Запуск процедуры подтверждения прав
Запускает процедуру подтверждения прав на управление сайтом.
Внимание
Перед использованием данного запроса получите уникальный код подтверждения и выберите способ подтверждения прав. Подробно см. пример.
Формат запроса
Отправьте POST-запрос на адрес ресурса подтверждения сайта пользователя. Обязательно укажите способ подтверждения GET-параметром. В теле запроса можно передавать произвольные данные или не передавать ничего.
POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/verification
? verification_type=<string>
|
|
Тип: |
|
|
Тип: |
|
|
Способ подтверждения прав (ApiExplicitVerificationType) |
* Обязательный параметр
Формат ответа
Пример
JSONXMLHTTP/1.1 200 OK { "verification_uin": "b01288afe67b1595", "verification_state": "IN_PROGRESS", "verification_type": "HTML_FILE", "applicable_verifiers": [ "HTML_FILE" ] }<Data> <verification_uin>b01288afe67b1595</verification_uin> <verification_state>IN_PROGRESS</verification_state> <verification_type>HTML_FILE</verification_type> <applicable_verifier>HTML_FILE</applicable_verifier> </Data>
Имя
Обязательный
Тип
Описание
verification_uinДа
stringКод подтверждения.
verification_stateДа
string(ApiVerificationState)Состояние подтверждения прав.
verification_typeДа
string(ApiVerificationType)Тип подтверждения прав.
applicable_verifiersДа
string(ApiExplicitVerificationType )Способы подтверждения, применимые для выбранного сайта.
Статус подтверждения прав на управление сайтом (ApiVerificationState)
|
Статус |
Описание |
|
|
Проверка не проводилась, права не подтверждены. |
|
|
Права подтверждены. |
|
|
Идет подтверждение прав. |
|
|
Проверка проводилась, права не подтверждены. |
|
|
В процессе проверки прав произошла непредвиденная ошибка. |
Способы подтверждения прав (ApiVerificationType)
|
Способ подтверждения |
Возможность запроса проверки подтверждения |
Описание |
|
|
Нет |
Автоматическое подтверждение прав (устаревшее, только для сайтов *.narod.ru). |
|
|
Нет |
Права делегированы. |
|
|
Есть |
Подтверждение прав с помощью DNS-записи. |
|
|
Есть |
Размещение HTML-файла в корневом каталоге сайта. |
|
|
Есть |
Добавление метатега в заголовок главной страницы сайта. |
|
|
Нет |
Размещение текстового файла в корневом каталоге сайта. |
Явные способы подтверждения прав (ApiExplicitVerificationType)
|
Способ подтверждения |
Возможность запроса проверки подтверждения |
Описание |
|
|
Есть |
Подтверждение прав с помощью DNS-записи. |
|
|
Есть |
Размещение HTML-файла в корневом каталоге сайта. |
|
|
Есть |
Добавление метатега в заголовок главной страницы сайта. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
|
Код |
Причина |
Описание |
|
200 |
OK |
|
|
403 |
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже JSON
XML
|
|
|
404 |
Сайт отсутствует в списке сайтов пользователя. JSON
XML
|
|
|
409 |
Процесс подтверждения прав уже запущен. JSON
XML
|
|
|
422 |
Перед подтверждением необходимо получить уникальный код. 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 сайта.
Описание
Признак подтверждения сайта.
Описание
ID файла Sitemap.
Описание
Список поддерживаемых типов контента.
Описание
Лимит на количество добавленных сайтов.
Описание
Лимит количества фидов.
Описание
Лимит количества добавленных фидов.
Описание
ID пользователя, от имени которого разрешен доступ.
Описание
Дата и время, до которого адрес доступен для создания задачи.
Описание
Список поддерживаемых типов контента.
Описание
Список поддерживаемых типов кодировки.
Описание
Максимальная длина.
Описание
Минимальная длина.
Описание
Доступное количество запросов в сутки.
Способ подтверждения прав (ApiExplicitVerificationType)
Явные способы подтверждения прав (ApiExplicitVerificationType)
|
Способ подтверждения |
Возможность запроса проверки подтверждения |
Описание |
|
|
Есть |
Подтверждение прав с помощью DNS-записи. |
|
|
Есть |
Размещение HTML-файла в корневом каталоге сайта. |
|
|
Есть |
Добавление метатега в заголовок главной страницы сайта. |
Обязательный
Да
Тип
string
Описание
Код подтверждения.
Обязательный
Да
Тип
string (ApiVerificationState)
Описание
Состояние подтверждения прав.
Обязательный
Да
Тип
string (ApiVerificationType)
Описание
Тип подтверждения прав.