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

Запускает процедуру подтверждения прав на управление сайтом.

Внимание

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

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

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

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

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

verification_type*

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

* Обязательный параметр

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

Пример

HTTP/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 )

Способы подтверждения, применимые для выбранного сайта.

Статус

Описание

NONE

Проверка не проводилась, права не подтверждены.

VERIFIED

Права подтверждены.

IN_PROGRESS

Идет подтверждение прав.

VERIFICATION_FAILED

Проверка проводилась, права не подтверждены.

INTERNAL_ERROR

В процессе проверки прав произошла непредвиденная ошибка.

Способ подтверждения

Возможность запроса проверки подтверждения

Описание

AUTO

Нет

Автоматическое подтверждение прав (устаревшее, только для сайтов *.narod.ru).

DELEGATED

Нет

Права делегированы.

DNS

Есть

Подтверждение прав с помощью DNS-записи.

HTML_FILE

Есть

Размещение HTML-файла в корневом каталоге сайта.

META_TAG

Есть

Добавление метатега в заголовок главной страницы сайта.

TXT_FILE

Нет

Размещение текстового файла в корневом каталоге сайта.

Способ подтверждения

Возможность запроса проверки подтверждения

Описание

DNS

Есть

Подтверждение прав с помощью DNS-записи.

HTML_FILE

Есть

Размещение HTML-файла в корневом каталоге сайта.

META_TAG

Есть

Добавление метатега в заголовок главной страницы сайта.

Коды ответа

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

Код

Причина

Описание

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."
}
<Data>
    <error_code>INVALID_USER_ID</error_code>
    <available_user_id>1</available_user_id>
    <error_message>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_FOUND

Сайт отсутствует в списке сайтов пользователя.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
<Data>
    <error_code>HOST_NOT_FOUND</error_code>
    <host_id>http:ya.ru:80</host_id>
    <error_message>explicit error message</error_message>
</Data>

409

VERIFICATION_ALREADY_IN_PROGRESS

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

{
  "error_code": "VERIFICATION_ALREADY_IN_PROGRESS",
  "verification_type": "META_TAG",
  "error_message": "some string"
}
<Data>
  <error_code>VERIFICATION_ALREADY_IN_PROGRESS</error_code>  
  <verification_type>META_TAG</verification_type> 
  <error_message>some string</error_message>
</Data>

422

NO_VERIFICATION_RECORD

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

{
  "error_code": "NO_VERIFICATION_RECORD",
  "error_message": "some string"
}
<Data>
  <error_code>NO_VERIFICATION_RECORD</error_code>  
  <error_message>some string</error_message>
</Data>

Узнайте больше

Тип: 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

Есть

Подтверждение прав с помощью DNS-записи.

HTML_FILE

Есть

Размещение HTML-файла в корневом каталоге сайта.

META_TAG

Есть

Добавление метатега в заголовок главной страницы сайта.

Обязательный

Да

Тип

string

Описание

Код подтверждения.

Обязательный

Да

Тип

string (ApiVerificationState)

Описание

Состояние подтверждения прав.

Обязательный

Да

Тип

string (ApiVerificationType)

Описание

Тип подтверждения прав.