Запуск процедуры подтверждения прав

Описание

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

Примечание. Перед использованием данного запроса необходимо получить уникальный код подтверждения и выбрать способ подтверждения прав. Подробно см. пример.

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

Отправьте POST-запрос на адрес ресурса подтверждении сайта пользователя. Обязательно укажите способ подтверждения GET-параметром. В теле запроса можно передавать произвольные данные или не передавать ничего.

POST https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/verification/?verification_type={verification_type}

Path-параметры

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

Query-параметры

Имя Обязательный Тип Описание
verification_type Да ApiExplicitVerificationType Способ подтверждения прав.

Явные способы подтверждения прав (ApiExplicitVerificationType)

Способ подтверждения Возможность запроса проверки подтверждения Описание
DNS Есть Подтверждение прав с помощью DNS-записи.
HTML_FILE Есть Размещение HTML-файла в корневом каталоге сайта.
META_TAG Есть Добавление мета-тега в заголовок главной страницы сайта.
WHOIS Есть

Сверка данных с информацией, предоставляемой сервисом WHOIS.

Метод работает только для доменов второго уровня (например, example.com).

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

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

Пример

HTTP/1.1 200 OK
{
  "verification_uin": "b01288afe67b1595",
  "verification_state": "IN_PROGRESS",
  "verification_type": "HTML_FILE",
  "applicable_verifiers": [
    "HTML_FILE"
  ]
}
Имя Обязательный Тип Описание
verification_uin Да string Код подтверждения.
verification_state Да ApiVerificationState Состояние подтверждения прав.
verification_type Да ApiVerificationType Тип подтверждения прав.
applicable_verifiers Да ApiExplicitVerificationType Способы подтверждения, применимые для выбранного сайта.

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

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

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

Ошибки

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 Сообщение об ошибке.

409 Conflict

Процесс подтверждения прав уже запущен.

{
  "error_code": "VERIFICATION_ALREADY_IN_PROGRESS",
  "host_id": "http:ya.ru:80",
  "verified": false,
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
verification_type Тип подтверждения, которое сейчас обрабатывается ( ApiExplicitVerificationType ).
error_message Сообщение об ошибке.