Получение списка сайтов пользователя
Возвращает список сайтов, добавленных пользователем, и сводную информацию о каждом из них.
Формат запроса
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts
user-id | Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user. |
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 | Да | Главный адрес сайта, если есть. |
Имя | Обязательный | Тип | Описание |
---|---|---|---|
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 | В процессе проверки прав произошла непредвиденная ошибка. |
Статус | Описание |
---|---|
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-файла задано неверно. |
Причина отказа | Описание |
---|---|
DELEGATION CANCELLED | Делегирование прав отменено. |
DNS_RECORD_NOT_FOUND | Отсутствует указанная DNS-запись. |
META_TAG_NOT_FOUND | Отсутствует метатег в заголовке главной страницы сайта. |
PDD_VERIFICATION_CANCELLED | Для данного сайта не разрешено подтверждение прав через Почту Для Домена. |
WHOIS_EMAIL_NOT_FOUND | Указанный адрес электронной почты отсутствует в записи WHOIS для данного сайта. |
WRONG_HTML_PAGE_CONTENT | Содержимое HTML-файла задано неверно. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
Код | Причина | Описание |
---|---|---|
200 | OK | |
403 | ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже |
Код | Причина | Описание |
---|---|---|
200 | OK | |
403 | ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже |