Добавление сайта

Описание

Позволяет добавить сайт в список сайтов пользователя.

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

Отправьте POST-запрос на адрес ресурса списка сайтов пользователя, в теле запроса укажите имя нового сайта, а также требуемый тип данных в заголовке Content-type (application/json или application/xml):

POST https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/
Content-type: application/xml

Path-параметры

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

Пример

{
  "host_url": "http://example.com"
}
Параметр Описание
host_url URI добавляемого сайта.

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

В случае успешного добавления сайта сервер возвращает 201 Created и URI ресурса сайта.

Пример

{
  "host_id": "http:example.com:80"
}
Параметр Описание
host_id ID добавленного сайта.

Ошибки

403 Forbidden

  • Код ошибки HOSTS_LIMIT_EXCEEDED

    Превышен лимит количества сайтов в списке сайтов пользователя (текущий лимит - 1703).

    {
     "error_code": "HOSTS_LIMIT_EXCEEDED",
     "limit": 1,
     "error_message": "explicit error message"
    }
    Параметр Описание
    error_code Код ошибки.
    limit Лимит на количество добавленных сайтов.
    error_message Сообщение об ошибке.
  • Код ошибки 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."
    }
    Параметр Описание
    error_code Код ошибки.
    available_user_id ID пользователя, от имени которого разрешен доступ.
    error_message Сообщение об ошибке.

409 Conflict

Сайт с таким именем уже добавлен в список сайтов пользователя.

{
  "error_code": "HOST_ALREADY_ADDED",
  "host_id": "http:ya.ru:80",
  "verified": false,
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
host_id ID сайта, который уже добавлен.
verified Подтвержден ли добавленный сайт.
error_message Сообщение об ошибке.