API: обзор партнёрского инструмента

Что такое API

API — это интерфейс для программного доступа, с помощью которого партнёр может отправить запрос к серверу бренда и в ответ получить необходимые данные. Например, о доступности автомобиля в определённой локации, о стоимости экскурсии и другие.

Партнёры используют API для гибкой работы с товарами и услугами брендов: интерпретируют полученные данные в нужном формате на веб-сайтах или в мобильных приложениях. С этим инструментом работают не только соло-вебмастеры, но и представители сервисов, которые развивают собственный бренд. Обычно такие партнёры имеют большую аудиторию. Если вы хотите привлекать в свою программу владельцев площадок с хорошим трафиком, предоставьте партнёрам API.

Пример работы API

Рассмотрим примеры работы с API, чтобы понять, как партнёр может взаимодействовать с этим инструментом.

Через API WeAtlas партнёры отправляют GET запрос, в который включают всё, что хотят получить в ответ. Такой запрос выглядит следующим образом:

curl -X GET ‘http://api.travelpayouts.com/weatlas/v1/search_prices_by_iata?code=ROM&from_date=2021-12-01T08:00&to_date=2021-12-05T08:00&currency=RUB&adults_count=2&children_count=11&language=ru 

-H ‘X-Access-Token: уникальный токен’

В этом запросе партнёр передаёт следующую информацию:

• code — IATA-код страны или города;
• currency — валюта, в которой вернётся цена предложения;
• date — дата поездки и возврата;
• limit — общее количество предложений на странице; 
• adults_count — количество взрослых; 
• children_count — количество детей;
• language — язык, на котором вернутся данные.

В ответ вебмастер получает информацию:

{
 "data": [
   {
     "price": 1800,
     "currency": "RUB",
     "content": "Ежедневная обзорная экскурсия по Москве (синий маршрут)",
     "excursion_type": "Пешая",
     "activity_type": "Group",
     "city_iata": "MOW",
     "country_iata": "RU",
     "link": "https://weatlas.com/excursions/11979?aid=10690&utm_source=Travelpayouts&utm_content=11979",
     "photo": "",
     "duration": "2 часа",
     "available_dates": [
       "2021-06-01T15:15:00+03:00",
       "2021-06-03T15:15:00+03:00"
     ]
    }
 }

Полученный ответ партнёр может интерпретировать по своему усмотрению. Например, одни данные вывести в определённом месте интерфейса, другие — подставить в поисковую форму, третьи — использовать для формирования ссылки.

По такому же принципу работает API от Discover Cars, но помимо GET запросов, как у WeAtlas, он поддерживает ещё и POST запросы. Подробнее узнать об отличиях этих методов можно в шпаргалке от HTML Academy.

Discover Cars на своём официальном сайте разместили подробную документацию по работе с API — такая информация помогает партнёрам быстрее разобраться с инструментом и протестировать его в работе.

Как осуществляется доступ к API

В партнёрской сети Travelpayouts нет ни одного бренда, который предоставляет API для работы с данными в реальном времени без запроса. Поэтому этот инструмент предоставляется партнёрам после модерации: бренду важно узнать, как партнёр будет использовать полученные данные.

Бренды часто устанавливают конкретные требования к партнёрам, которые будут работать с API. Например, Discover Cars предоставляет доступ к этому инструменту партнёрам, у которых:

• число посетителей площадки — от 50 000 в месяц;
• тематика площадки — тревел;
• проект — классическое OTA, поисковик с трафиком (например, поиск услуг), сайт, который активно продаёт туристические услуги.

Некоторые партнёры могут использовать данные не для продажи услуг или товаров брендов, а для формирования собственных данных. Например, сайт о погоде может получать через API партнёрской программы авиабилетов список аэропортов в стране, но не использовать эти данные для продажи билетов.
Если вы не готовы отдавать данные сервису, который не продаёт ваши услуги, то можете отказать партнёру в доступе к API.

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

Если партнёр нарушает условия использования API, вы можете закрыть ему доступ к этому инструменту.

Как разработать API

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

Альтернативное решение

API — уникальный и гибкий инструмент, у которого нет точного аналога. Если вы не готовы предоставить партнёрам API или хотите дополнить этот инструмент, то можете предоставить данные в другом удобном формате.

Например, Omio предоставляет данные в формате файла, который включает:

• id — уникальный идентификатор направления в системе Omio;
• title — заголовок направления;
• link — ссылка на результаты поиска по направлению;
• price — стоимость;
• currency — валюта;
• description — дополнительное описание.

Такие данные полноценно не заменяют API, потому что не обновляются в реальном времени, но даже эту информацию партнёры используют для работы с контентом.

Предлагать API на старте партнёрской программы необязательно, но в процессе работы этот инструмент стоит добавить. 

Команда Travelpayouts поможет разработать API для вашей партнёрской программы и расскажет о других инструментах. Подключайтесь к платформе Travelpayouts, чтобы привлекать новых клиентов через канал партнёрского маркетинга.