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

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

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

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

user-id

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

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

Пример

{
  "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://Яндекс рф/"
      }
    }, ...
  ]
}

<Data>
    <host>
        <host_id>http:ya.ru:80</host_id>
        <ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
        <unicode_host_url>http://Яндекс рф/</unicode_host_url>
        <verified>yes</verified>
        <main_mirror>
            <host_id>http:ya.ru:80</host_id>
            <verified>false</verified>
            <ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
            <unicode_host_url>http://Яндекс рф/</unicode_host_url>
        </main_mirror>
    </host>
    ...
</Data>

Имя

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

Тип

Описание

host_id

Да

host id (string)

ID сайта.

ascii_host_url

Да

string

ASCII URL сайта.

unicode_host_url

Нет

string

UTF-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

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

WRONG_HTML_PAGE_CONTENT

Содержимое HTML-файла задано неверно.

Коды ответа

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

Код

Причина

Описание

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

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

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

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

Да

Тип

host id (string)

Описание

ID сайта.

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

Да

Тип

string

Описание

ASCII URL сайта.

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

Нет

Тип

string

Описание

UTF-8 URL сайта.

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

Да

Тип

boolean

Описание

Подтвержден ли сайт.

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

Да

Тип

Описание

Главный адрес сайта, если есть.

Предыдущая
Получение идентификатора пользователя
Следующая
Добавление сайта