Получение информации о сайте
Внимание. Вы открыли документацию API версии 3.2. Яндекс Вебмастер перестал поддерживать версию 3.2 и ниже со второго полугодия 2020 г. Рекомендуем использовать API версии 4.1.
Возвращает информацию о сайте.
Формат запроса
GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/
Path-параметры
Имя | Обязательный | Тип | Значение по умолчанию | Описание |
---|---|---|---|---|
user-id | Да | int64 | ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user. | |
host-id | Да | host id | ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts. |
Имя | Обязательный | Тип | Значение по умолчанию | Описание |
---|---|---|---|---|
user-id | Да | int64 | ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user. | |
host-id | Да | host id | ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts. |
Формат ответа
Пример
{
"host_id": "https:ya.ru:443",
"verified": true,
"ascii_host_url": "https://ya.ru/",
"unicode_host_url": "https://ya.ru/",
"main_mirror": {
"host_id": "http:xn--d1acpjx3f.xn--p1ai:80",
"ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
"unicode_host_url": "http://Яндекс рф/",
"verified": false
},
"host_data_status": "NOT_INDEXED",
"host_display_name": "Ya.ru"
}
<Data>
<host_id>https:ya.ru:443</host_id>
<verified>true</verified>
<ascii_host_url>https://ya.ru/</ascii_host_url>
<unicode_host_url>https://ya.ru/</unicode_host_url>
<main_mirror>
<host_id>http:xn--d1acpjx3f.xn--p1ai:80</host_id>
<ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
<unicode_host_url>http://Яндекс рф/</unicode_host_url>
<verified>false</verified>
</main_mirror>
<host_data_status>NOT_INDEXED</host_data_status>
<host_display_name>Ya.ru</host_display_name>
</Data>
Имя | Обязательный | Тип | Описание |
---|---|---|---|
host_id | Да | host id | ID запрошенного сайта. |
ascii_host_url | Да | string | ASCII URL сайта |
unicode_host_url | Да | string | UTF-8 URL сайта. |
verified | Да | boolean | Подтвержден ли сайт. |
main_mirror | Нет | Главный адрес сайта, если есть. | |
host_data_status | Нет | ApiHostDataStatus | Информация о сайте (показывается, если сайт подтвержден). |
host_display_name | Нет | string | Отображаемое имя сайта. |
Имя | Обязательный | Тип | Описание |
---|---|---|---|
host_id | Да | host id | ID запрошенного сайта. |
ascii_host_url | Да | string | ASCII URL сайта |
unicode_host_url | Да | string | UTF-8 URL сайта. |
verified | Да | boolean | Подтвержден ли сайт. |
main_mirror | Нет | Главный адрес сайта, если есть. | |
host_data_status | Нет | ApiHostDataStatus | Информация о сайте (показывается, если сайт подтвержден). |
host_display_name | Нет | string | Отображаемое имя сайта. |
Статус индексирования сайта (ApiHostDataStatus)
Источник | Описание |
---|---|
NOT_INDEXED | Сайт еще не проиндексирован. |
NOT_LOADED | Данные о сайте еще не загружены в Яндекс Вебмастер. |
OK | Сайт проиндексирован, данные доступны в Яндекс Вебмастере. |
Источник | Описание |
---|---|
NOT_INDEXED | Сайт еще не проиндексирован. |
NOT_LOADED | Данные о сайте еще не загружены в Яндекс Вебмастер. |
OK | Сайт проиндексирован, данные доступны в Яндекс Вебмастере. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
Код | Причина | Описание |
---|---|---|
200 | OK | |
403 | ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже | |
404 | HOST_NOT_FOUND | Сайт отсутствует в списке сайтов пользователя. |
Код | Причина | Описание |
---|---|---|
200 | OK | |
403 | ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже | |
404 | HOST_NOT_FOUND | Сайт отсутствует в списке сайтов пользователя. |