Получение ссылки для загрузки RSS-канала

Возвращает ссылку для загрузки RSS-канала. Ссылка действительна в течение 10 минут после ее получения.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа
  4. Пример

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/turbo/uploadAddress
 ? [mode=<string>]
Path-параметры
user-idИдентификатор пользователя. Значение можно получить с помощью операции GET /v4/user.
host-id
Идентификатор сайта. Имеет формат scheme:host:port, где
  • scheme — протокол http или https.
  • host — адресс сайта с www или без.
  • port — порт для подключения. Для протокола http — 80, для https — 443.

Например: https:example.com:443 или http:www.example.com:80.

Также идентификатор сайта можно получить с помощью операции GET /user/{user-id}/hosts.

Query-параметры
mode
Режим загрузки RSS-канала. Возможные значения:
  • PRODUCTION — публикация.
  • DEBUG — режим отладки.

Значение по умолчанию: PRODUCTION.

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

Сервис возвращает данные в формате JSON (по умолчанию) или XML. Чтобы получить XML-ответ, передайте в запросе HTTP-заголовок Accept: application/xml.

{
  "valid_until": "YYYY-MM-DDThh:mm:ss±hh:mm",
  "upload_address": "string"
}
valid_until

Дата и время, до которого адрес доступен для загрузки (10 минут после запроса).

upload_address

Ссылка для создания задачи на загрузку RSS-канала.

Коды ответа

Код Описание
200 OK Запрос выполнен успешно.
403 Forbidden
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
Сообщение об ошибке.
404 Not Found
HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
Пример ответа
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
error_code
Код ошибки.
host_id
ID запрошенного сайта.
error_message
Сообщение об ошибке.

Пример

Запрос:

curl -X GET \
  'https://api.webmaster.yandex.net/v4/user/12345678/hosts/https:example.com:443/turbo/uploadAddress?mode=DEBUG' \
  -H 'Authorization: OAuth oauth_token'

Ответ:

{
  "valid_until": "2018-11-10T18:12:22.085+03:00",
  "upload_address": "https://api.webmaster.yandex.net/v3.2/upload/turbo/yXOkhVGtFtUiZfRBJxIivnlHW90o5jrpBhFSjnGg_yMyg7tYc9sGsOtDSkaGQx-N_2i_2bQxgvUk1gbxreD_uA"
}