Content API — описание объектов размещения

Какие данные синхронизируются

На схеме показаны этапы получения описания средства размещения, категорий номеров, тарифов, услуг, фотографий в Content API — инструмент, который позволяет управлять контентом (далее — Content API):

Синхронизация работает только по объектам, которые настроят интеграцию с каналом продаж в менеджере каналов.

Мы не проверяем данные, которые отельеры добавляют в личном кабинете. Канал продаж при получении данных в Content API может проверить данные самостоятельно. Как правило, отели хорошо следят за контентом, так как эта информация отображается на официальном сайте при помощи модуля бронирования TL: Booking Engine.

Как получить полное описание всех объектов размещения

В методе /v1/properties Content API впишите all в поле include.

Получение контента на английском языке

В методе /v1/properties и /v1/properties/{propertyId} Content API вы можете получать контент средства размещения не только на языке личного кабинета, который установлен по умолчанию, но и на английском языке. Для этого добавьте en в поле languageCode.

В каком порядке отображаются изображения в api/content и api/search

Порядок устанавливается отельером в личном кабинете TravelLine. Каналу продаж необходимо реализовать порядок отображения изображений средства размещения или категории номера, который приходит по API — прикладной программный интерфейс (далее API).

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

В методе Geo API V1 можно получить список объектов по стране, региону, городу. Например, для получения списка объектов по стране, выберите Geo API V1 → /v1/countries/{countryCode}/properties:

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

Можно ли в TravelLine внести данные для конкретного канала

Такие данные средство размещения заполняет на стороне канала. TravelLine может разместить только общую информацию и ссылку на ваш канал, при переходе по которой отельер сможет заполнить все необходимые данные на вашей стороне. Пример того, что будет видеть отельер:

Пример ссылки на форму регистрации.

Информация о кроватях в номере

В теле ответа методов описания объектов размещений появились «Оснащения номеров» — roomTypes.amenities. Реализован справочник «Оснащения номеров» — /v1/room-amenity-categories.

Отправка событий каналам продаж через API

Каналы продаж могут получать события, чтобы оперативно реагировать на изменение данных в TravelLine. Событийная модель реализована на основе вебхуков — инструмента передачи данных между разными системами (далее — вебхук). На схеме показаны этапы получения событий при изменении данных в Content API:

Виды событий:

• Добавление прав на средство размещения в рамках партнера (канала продаж) — propertyAdded.

• Удаление прав на средство размещения в рамках партнера (канала продаж) — PropertyDeleted.

• Изменение подключенного средства размещения к партнеру (каналу продаж). При обновлении информации о средстве размещения, включая изменения контента гостиницы или прав партнера, отправляются вебхуки на изменение средства размещения — используется событие PropertyModified.

Способ получения событий:

Канал продаж реализует на своей стороне публичный API endpoint (конечная точка, далее — endpoint), принимающий события, к которому Платформа TravelLine может обращаться с авторизованным доступом.

При изменении контентной информации отельером на стороне TravelLine: описание и фото средства размещения, категорий номеров и тарифов — Платформа TravelLine направляет вебхуки о том, что данные изменились, с помощью обращения к публичному endpoint.

Особенности:

• При получении ответа со статусом, отличным от 200, платформа TravelLine производит попытку повторного запроса. Задержка перед отправкой повторного запроса составляет 1 секунду.

• Перерыв при отправке событий — 45 секунд.

• События хранятся 3 дня.

Пример запроса:

Параметры:

• entityId — идентификатор сущности, по которой произошло изменение (средство размещения);

• eventType — тип события;

• eventCreationTime — время, когда событие произошло.

Периодичность отправки событий: события направляются пачками каждые 2 минуты, если за этот промежуток времени появились события для отправки. События в рамках одной пачки могут повторяться, в случае если произошло несколько изменений.

На первом этапе подписки на события необходимо предоставить следующие данные:

• Типы событий: укажите, какие события вы хотите получать.

• Адрес веб-страницы, на который будут отправляться уведомления.

• Авторизационные данные: выберите и укажите тип аутентификации.

Мы поддерживаем два типа аутентификации:

• API-KEY Auth: для этого типа аутентификации необходимо предоставить API-ключ, который будет использоваться для защиты запросов.

• Basic Auth: для этого типа аутентификации необходимо предоставить логин и пароль.

Вы можете выбрать наиболее подходящий для вас тип аутентификации.

Обратите внимание. При получении вебхуков важно сохранить текущий принцип актуализации контента — обращение к методам Content API — 1 раз в сутки в ночное время, так как платформа TravelLine не гарантирует доставку всех сообщений до партнеров.

Как найти данные в конкретном регионе

1. Получаете список объектов в регионе: /api/geo/​v1​/regions​/{regionId}​/properties.

2. Передаете список объектов в метод поиска: /api/search/​v1​/properties​/room-stays​/search.

Как найти данные в конкретном городе

1. Получаете список объектов в городе: /api/geo/v1​/cities​/{cityId}​/properties.

2. Передаете список объектов в метод поиска: /api/search/v1/properties/room-stays/search.