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

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

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

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

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

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/verification/?verification_type={verification_type}

Path-параметры

ИмяОбязательныйТипЗначение по умолчаниюОписание
user-idДаint64ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-idДаhost idID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.

Query-параметры

ИмяОбязательныйТипОписание
verification_typeДаApiExplicitVerificationTypeСпособ подтверждения прав.

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

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

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

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

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

Пример

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ДаApiVerificationStateСостояние подтверждения прав.
verification_typeДаApiVerificationTypeТип подтверждения прав.
applicable_verifiersДаApiExplicitVerificationTypeСпособы подтверждения, применимые для выбранного сайта.

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

СтатусОписание
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).

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

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

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

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

Коды ответа

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

КодПричинаОписание
200OK
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."
}
404HOST_NOT_FOUND

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

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