Получение списка сайтов пользователя

Описание

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

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

Отправьте GET-запрос на адрес ресурса списков сайта пользователя:

GET https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/

Path-параметры

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

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

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

Пример

{
  "hosts": [
    {
      "host_id": "http:ya.ru:80",
      "ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
      "unicode_host_url": "http://яндекс.рф/",
      "verified": true,
      "main_mirror": {
        "host_id": "http:ya.ru:80",
        "verified": true,
        "ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
        "unicode_host_url": "http://яндекс.рф/"
      }
    }, ...
  ]
}
ИмяОбязательныйТипОписание
host_idДаhost idID сайта.
ascii_host_urlДаstringASCII URL сайта
unicode_host_urlНетstringUTF-8 URL сайта.
verifiedДаbooleanПодтвержден ли сайт.
main_mirrorДаГлавное зеркало сайта, если есть.

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

СтатусОписание
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-файла задано неверно.

Ошибки

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_idID пользователя, от имени которого разрешен доступ.
error_messageСообщение об ошибке.