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

Описание

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

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

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

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

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод 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_id ID пользователя, от имени которого разрешен доступ.
error_message Сообщение об ошибке.

404 Not Found

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

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