О работе с API для агрегаторов отелей

Используйте возможности API для передачи Яндексу данных об отелях, доступности и стоимости номеров, а также о бронированиях, совершенных после перехода с универсальных ответов в результатах поиска Яндекса на ваш сайт.

Для работы с API нужен авторизационный токен — узнайте его у вашего менеджера. Отправляйте токен с каждый запросом к API.

Лимитирование запросов

  • Ограничение RPS — 100.

  • Ограничение объема данных в одном запросе — 0,08 Мб.

  • При превышении ограничения будет приходить ответ с кодом HTTP-статуса 429 (Too Many Requests):

    • api/v1/hotels (получить данные о всех отелях): RPS — 1;
    • api/v1/hotels/{hotelId}/offers (получить все предложения отеля): RPS — 5;
    • api/v1/statistics-url (получить ссылку на статистики): RPS — 1.

Обзор ресурсов

API подключения агрегаторов доступен по адресу:

https://unisearch-hotels-pacific-partner-api.yandex.ru

Ниже приведен список ресурсов API и возможные операции над ними:

URI

GET

POST

DELETE

Работа с данными отелей

/hotels

Получить данные о всех отелях

Обновить или добавить новые данные об отелях

/hotels/hotelId

Получить данные об одном отеле

Обновить или добавить новые данные об одном отеле

Удалить данные об одном отеле

Работа с предложениями отелей

/hotels/hotelId/offers

Получить все предложения отеля

Обновить или добавить новые данные о предложениях отеля

Удалить данные о нескольких предложениях отеля по Id

/hotels/hotelId/offers/offerId

Получить одно предложение отеля

Обновить или добавить новые данные об одном предложении

Удалить данные об одном предложении

/offers

Обновить или добавить новые данные о предложениях нескольких отелей

Удалить данные о предложениях нескольких отелей

Данные о заказах

/orders

Отправить данные о заказах

Статистики

/statistics-url

Получить ссылки на статистики

Получить предложения одного отеля по параметрам поиска

/hotels/hotelId/service-offers

Проверка сформированных предложений для отображения на выдаче из загруженных данных

Схема взаимодействия через API

Отображение кешбэка

Параметр

Обязательно

Описание

Примечание

promoId

Да

Идентификатор программы. Определяет:

  • к каким предложениям в фиде относится кешбэк;
  • какой группе пользователей доступен кешбэк. Например, для одной группы пользователей доступен кешбэк 10% — для нее назначается один идентификатор. Для другой группы кешбэк составляет 15% — для нее назначается другой идентификатор.

Один пользователь может участвовать в 5 программах.

cashback

Да

Сумма кешбэка. Например, 10.

Фиксируется в процентах или в размере кэшбека.

dateFrom

Нет

Дата начала действия вашей программы кешбэка.

Например, 28.06.2023.

dateTo

Нет

Дата окончания действия вашей программы кешбэка.

Например, 29.06.2023.

phoneHash

Да

Номер телефона пользователя.

Перед отправкой данных используйте хеширование. Информация нужна для определения пользователей, для которых доступен кешбэк, — у таких пользователей отображение кешбэка включено по умолчанию.

emailHash

Да

Адрес электронной почты пользователя.

Перед отправкой данных используйте хеширование. Информация нужна для определения пользователей, для которых доступен кешбэк, — у таких пользователей отображение кешбэка включено по умолчанию.

Количество отравляемых запросов в секунду.

Предыдущая
Следующая