Получение информации о подтверждении сайта
Возвращает информацию о текущем состоянии подтверждения сайта в Яндекс Вебмастере.
Формат запроса
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/verification
|
Тип: |
|
Тип: |
Формат ответа
Примеры
JSONXML
{ "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", ... ] }
<Data> <verification_uin>b01288afe67b1595</verification_uin> <verification_state>NONE</verification_state> <verification_type>META_TAG</verification_type> <latest_verification_time>2016-01-01T00:00:00,000+0300</latest_verification_time> <fail_info> <reason>META_TAG_NOT_FOUND</reason> <message>explicit error message</message> </fail_info> <applicable_verifier>META_TAG</applicable_verifier> ... </Data>
Имя
Обязательный
Тип
Описание
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)Способы подтверждения, применимые для выбранного сайта.
Способ подтверждения |
Возможность запроса проверки подтверждения |
Описание |
|
Нет |
Автоматическое подтверждение прав (устаревшее, только для сайтов *.narod.ru). |
|
Нет |
Права делегированы. |
|
Есть |
Подтверждение прав с помощью DNS-записи. |
|
Есть |
Размещение HTML-файла в корневом каталоге сайта. |
|
Есть |
Добавление метатега в заголовок главной страницы сайта. |
|
Нет |
Размещение текстового файла в корневом каталоге сайта. |
Способ подтверждения |
Возможность запроса проверки подтверждения |
Описание |
|
Есть |
Подтверждение прав с помощью DNS-записи. |
|
Есть |
Размещение HTML-файла в корневом каталоге сайта. |
|
Есть |
Добавление метатега в заголовок главной страницы сайта. |
Статус |
Описание |
|
Проверка не проводилась, права не подтверждены. |
|
Права подтверждены. |
|
Идет подтверждение прав. |
|
Проверка проводилась, права не подтверждены. |
|
В процессе проверки прав произошла непредвиденная ошибка. |
Причина отказа |
Описание |
|
Делегирование прав отменено. |
|
Отсутствует указанная DNS-запись. |
|
Отсутствует метатег в заголовке главной страницы сайта. |
|
Содержимое HTML-файла задано неверно. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
Код |
Причина |
Описание |
200 |
OK |
|
403 |
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже JSON
XML
|
|
404 |
Сайт отсутствует в списке сайтов пользователя. JSON
XML
|
Узнайте больше
Тип: int64
. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
Тип: host id (string)
. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.
Обязательный параметр
Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.
Количество записей (1-100). Значение по умолчанию: 10.
Описание
Код ошибки.
Описание
Сообщение об ошибке.
Описание
Значение.
Описание
Поле.
Описание
ID запрошенного сайта.
Описание
ID сайта.
Описание
Признак подтверждения сайта.
Способы подтверждения прав (ApiVerificationType)
Способ подтверждения |
Возможность запроса проверки подтверждения |
Описание |
|
Нет |
Автоматическое подтверждение прав (устаревшее, только для сайтов *.narod.ru). |
|
Нет |
Права делегированы. |
|
Есть |
Подтверждение прав с помощью DNS-записи. |
|
Есть |
Размещение HTML-файла в корневом каталоге сайта. |
|
Есть |
Добавление метатега в заголовок главной страницы сайта. |
|
Нет |
Размещение текстового файла в корневом каталоге сайта. |
Описание
ID файла Sitemap
.
Описание
Список поддерживаемых типов контента.
Описание
Лимит на количество добавленных сайтов.
Описание
Лимит количества фидов.
Описание
Лимит количества добавленных фидов.
Описание
ID пользователя, от имени которого разрешен доступ.
Описание
Дата и время, до которого адрес доступен для создания задачи.
Описание
Список поддерживаемых типов контента.
Описание
Список поддерживаемых типов кодировки.
Описание
Максимальная длина.
Описание
Минимальная длина.
Описание
Доступное количество запросов в сутки.
Статус подтверждения прав на управление сайтом (ApiVerificationState)
Статус |
Описание |
|
Проверка не проводилась, права не подтверждены. |
|
Права подтверждены. |
|
Идет подтверждение прав. |
|
Проверка проводилась, права не подтверждены. |
|
В процессе проверки прав произошла непредвиденная ошибка. |
Причины отказа в подтверждении прав на управление сайтом (ApiVerificationFailReason)
Причина отказа |
Описание |
|
Делегирование прав отменено. |
|
Отсутствует указанная DNS-запись. |
|
Отсутствует метатег в заголовке главной страницы сайта. |
|
Содержимое HTML-файла задано неверно. |
Обязательный
Да
Тип
string
Описание
Уникальный код подтверждения.
Обязательный
Да
Тип
string
(ApiVerificationState)
Описание
Состояние подтверждения прав.
Обязательный
Да
Тип
string
(ApiVerificationType)
Описание
Тип подтверждения прав.
Обязательный
Да
Тип
datetime
Описание
Время последней проверки в формате yyyy-MM-ddTHH:mm:ss,sssZ
(если verification_state
не равно NONE
).
Обязательный
Да
Тип
Описание
Описание ошибки, если получен статус VERIFICATION_FAILED
.
Обязательный
Да
Тип
string
(ApiVerificationFailReason)
Описание
Причина неудачной проверки.
Обязательный
Да
Тип
string
Описание
Описание ошибки для пользователей.
Обязательный
Да
Тип
string
(ApiExplicitVerificationType)
Описание
Способы подтверждения, применимые для выбранного сайта.