Запуск процедуры подтверждения прав

Запускает процедуру подтверждения прав на управление сайтом.

Внимание. Перед использованием данного запроса получите уникальный код подтверждения и выберите способ подтверждения прав. Подробно см. пример.
  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

Формат запроса

Отправьте POST-запрос на адрес ресурса подтверждения сайта пользователя. Обязательно укажите способ подтверждения GET-параметром. В теле запроса можно передавать произвольные данные или не передавать ничего.

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/verification
 ? verification_type=<string>
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
verification_type *Способ подтверждения прав (ApiExplicitVerificationType)
verification_type *Способ подтверждения прав (ApiExplicitVerificationType)

*  Обязательный параметр

Формат ответа

Пример

HTTP/1.1 200 OK
{
  "verification_uin": "b01288afe67b1595",
  "verification_state": "IN_PROGRESS",
  "verification_type": "HTML_FILE",
  "applicable_verifiers": [
    "HTML_FILE"
  ]
}
Имя Обязательный Тип Описание
verification_uin Да string Код подтверждения.
verification_state Да string (ApiVerificationState) Состояние подтверждения прав.
verification_type Да string (ApiVerificationType) Тип подтверждения прав.
applicable_verifiers Да string (ApiExplicitVerificationType ) Способы подтверждения, применимые для выбранного сайта.
Имя Обязательный Тип Описание
verification_uin Да string Код подтверждения.
verification_state Да string (ApiVerificationState) Состояние подтверждения прав.
verification_type Да string (ApiVerificationType) Тип подтверждения прав.
applicable_verifiers Да string (ApiExplicitVerificationType ) Способы подтверждения, применимые для выбранного сайта.

Статус подтверждения прав на управление сайтом (ApiVerificationState)

Статус Описание
NONE Проверка не проводилась, права не подтверждены.
VERIFIED Права подтверждены.
IN_PROGRESS Идет подтверждение прав.
VERIFICATION_FAILED Проверка проводилась, права не подтверждены.
INTERNAL_ERROR В процессе проверки прав произошла непредвиденная ошибка.
Статус Описание
NONE Проверка не проводилась, права не подтверждены.
VERIFIED Права подтверждены.
IN_PROGRESS Идет подтверждение прав.
VERIFICATION_FAILED Проверка проводилась, права не подтверждены.
INTERNAL_ERROR В процессе проверки прав произошла непредвиденная ошибка.

Способы подтверждения прав (ApiVerificationType)

Способ подтверждения Возможность запроса проверки подтверждения Описание
AUTO Нет Автоматическое подтверждение прав (устаревшее, только для сайтов *.narod.ru.
DELEGATED Нет Права делегированы.
DNS Есть Подтверждение прав с помощью DNS-записи.
HTML_FILE Есть Размещение HTML-файла в корневом каталоге сайта.
META_TAG Есть Добавление метатега в заголовок главной страницы сайта.
PDD Нет Подтверждение прав через Яндекс.Почту для доменов.
TXT_FILE Нет Размещение текстового файла в корневом каталоге сайта.
WHOIS Есть

Сверка данных с информацией, предоставляемой сервисом WHOIS.

Метод работает только для доменов второго уровня (например, example.com).

Способ подтверждения Возможность запроса проверки подтверждения Описание
AUTO Нет Автоматическое подтверждение прав (устаревшее, только для сайтов *.narod.ru.
DELEGATED Нет Права делегированы.
DNS Есть Подтверждение прав с помощью DNS-записи.
HTML_FILE Есть Размещение HTML-файла в корневом каталоге сайта.
META_TAG Есть Добавление метатега в заголовок главной страницы сайта.
PDD Нет Подтверждение прав через Яндекс.Почту для доменов.
TXT_FILE Нет Размещение текстового файла в корневом каталоге сайта.
WHOIS Есть

Сверка данных с информацией, предоставляемой сервисом WHOIS.

Метод работает только для доменов второго уровня (например, example.com).

Явные способы подтверждения прав (ApiExplicitVerificationType)

Способ подтверждения Возможность запроса проверки подтверждения Описание
DNS Есть Подтверждение прав с помощью DNS-записи.
HTML_FILE Есть Размещение HTML-файла в корневом каталоге сайта.
META_TAG Есть Добавление метатега в заголовок главной страницы сайта.
WHOIS Есть

Сверка данных с информацией, предоставляемой сервисом WHOIS.

Метод работает только для доменов второго уровня (например, example.com).

Способ подтверждения Возможность запроса проверки подтверждения Описание
DNS Есть Подтверждение прав с помощью DNS-записи.
HTML_FILE Есть Размещение HTML-файла в корневом каталоге сайта.
META_TAG Есть Добавление метатега в заголовок главной страницы сайта.
WHOIS Есть

Сверка данных с информацией, предоставляемой сервисом WHOIS.

Метод работает только для доменов второго уровня (например, example.com).

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код Причина Описание
200 OK
403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_FOUND

Сайт отсутствует в списке сайтов пользователя.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
409 VERIFICATION_ALREADY_IN_PROGRESS
Процесс подтверждения прав уже запущен.
{
  "error_code": "VERIFICATION_ALREADY_IN_PROGRESS",
  "verification_type": "META_TAG",
  "error_message": "some string"
}
Код Причина Описание
200 OK
403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_FOUND

Сайт отсутствует в списке сайтов пользователя.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
409 VERIFICATION_ALREADY_IN_PROGRESS
Процесс подтверждения прав уже запущен.
{
  "error_code": "VERIFICATION_ALREADY_IN_PROGRESS",
  "verification_type": "META_TAG",
  "error_message": "some string"
}