Получение информации о подтверждении сайта

Описание

Позволяет получить подробную информацию о текущем состоянии подтверждения сайта в Яндекс.Вебмастере.

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

Отправьте GET-запрос на адрес ресурса информации о подтверждении сайта пользователя:

GET https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/verification/

Path-параметры

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

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

В случае успеха сервер возвращает 200 OK и данные о текущем состоянии подтверждения сайта.

Примеры

{
  "verification_uin": "b01288afe67b1595",
  "verification_state": "NONE",
  "verification_type": "META_TAG",
  "latest_verification_time": "2016-01-01T00:00:00,000+0300",
  "fail_info": {
    "reason": "META_TAG_NOT_FOUND",
    "message": "explicit error message"
  },
  "applicable_verifiers": [
    "META_TAG", ...
  ]
}
ИмяОбязательныйТипОписание
verification_uinДаstringУникальный код подтверждения.
verification_stateДаApiVerificationStateСостояние подтверждения прав.
verification_typeДаApiVerificationTypeТип подтверждения прав.
latest_verification_timeДаyyyy-MM-ddTHH:mm:ss,sssZВремя последней проверки (если verification_state не равно NONE).
fail_infoДаОписание ошибки, если получен статус VERIFICATION_FAILED.
reasonДаApiVerificationFailReasonПричина неудачной проверки.
messageДаstringОписание ошибки для пользователей.
applicable_verifiersДаApiExplicitVerificationTypeСпособы подтверждения, применимые для выбранного сайта.

Способы подтверждения прав (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).

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

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

Причины отказа в подтверждении прав на управление сайтом (ApiVerificationFailReason)

Причина отказаОписание
DELEGATION CANCELLEDДелегирование прав отменено.
DNS_RECORD_NOT_FOUNDОтсутствует указанная DNS-запись.
META_TAG_NOT_FOUNDОтсутствует мета-тег в заголовке главной страницы сайта.
PDD_VERIFICATION_CANCELLEDДля данного сайта не разрешено подтверждение прав через Почту Для Домена.
WHOIS_EMAIL_NOT_FOUNDУказанный адрес электронной почты отсутствует в записи WHOIS для данного сайта.
WRONG_HTML_PAGE_CONTENTСодержимое HTML-файла задано неверно.

Ошибки

403 Forbidden

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

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
ПараметрОписание
error_codeКод ошибки.
available_user_idID пользователя, от имени которого разрешен доступ.
error_messageСообщение об ошибке.

404 Not Found

Сайт отсутствует в списке сайтов пользователя или на него не подтверждены права.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
ПараметрОписание
error_codeКод ошибки.
host_idID запрошенного сайта.
error_messageСообщение об ошибке.