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

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

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/verification
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_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 Да string (ApiVerificationState ) Состояние подтверждения прав.
verification_type Да string (ApiVerificationType) Тип подтверждения прав.
latest_verification_time Да datetime Время последней проверки в формате yyyy-MM-ddTHH:mm:ss,sssZ (если verification_state не равно NONE).
fail_info Да Описание ошибки, если получен статус VERIFICATION_FAILED .
reason Да string (ApiVerificationFailReason) Причина неудачной проверки.
message Да string Описание ошибки для пользователей.
applicable_verifiers Да string (ApiExplicitVerificationType ) Способы подтверждения, применимые для выбранного сайта.
Имя Обязательный Тип Описание
verification_uin Да string Уникальный код подтверждения.
verification_state Да string (ApiVerificationState ) Состояние подтверждения прав.
verification_type Да string (ApiVerificationType) Тип подтверждения прав.
latest_verification_time Да datetime Время последней проверки в формате yyyy-MM-ddTHH:mm:ss,sssZ (если verification_state не равно NONE).
fail_info Да Описание ошибки, если получен статус VERIFICATION_FAILED .
reason Да string (ApiVerificationFailReason) Причина неудачной проверки.
message Да string Описание ошибки для пользователей.
applicable_verifiers Да string (ApiExplicitVerificationType ) Способы подтверждения, применимые для выбранного сайта.

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

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

Статус Описание
NONE Проверка не проводилась, права не подтверждены.
VERIFIED Права подтверждены.
IN_PROGRESS Идет подтверждение прав.
VERIFICATION_FAILED Проверка проводилась, права не подтверждены.
INTERNAL_ERROR В процессе проверки прав произошла непредвиденная ошибка.
Статус Описание
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-файла задано неверно.
Причина отказа Описание
DELEGATION CANCELLED Делегирование прав отменено.
DNS_RECORD_NOT_FOUND Отсутствует указанная DNS-запись.
META_TAG_NOT_FOUND Отсутствует метатег в заголовке главной страницы сайта.
PDD_VERIFICATION_CANCELLED Для данного сайта не разрешено подтверждение прав через Почту Для Домена.
WHOIS_EMAIL_NOT_FOUND Указанный адрес электронной почты отсутствует в записи WHOIS для данного сайта.
WRONG_HTML_PAGE_CONTENT Содержимое HTML-файла задано неверно.

Коды ответа

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

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