Travelpayouts (Aviasales/JetRadar) API для Node.js

In English

(Минималистичная) обертка для API Travelpayouts (Aviasales/JetRadar).

Поддерживаются следующие API:

• данных

• поиска авиабилетов

• партнерской статистики

См. также: модуль для работы с файлами данных Travelpayouts — travelpayouts-data.

Содержание

• Установка
• Использование
• API
  • travelpayoutsAPI([options])
  • Все методы
  • Цены
    • prices.latest(options, callback)
    • prices.monthMatrix(options, callback)
    • prices.weekMatrix(options, callback)
    • prices.nearestPlacesMatrix(options, callback)
    • prices.cheap(options, callback)
    • prices.monthly(options, callback)
    • prices.direct(options, callback)
    • prices.calendar(options, callback)
    • prices.holidaysByRoutes(options, callback)
    • minPricesCalendar(options, callback)
    • specialOffers(callback)
  • Поиск авиабилетов
    • flight.search(params, callback)
    • flight.results(params, callback)
    • flight.click(params, callback)
  • Партнерская статистика
    • statistics.balance(callback)
    • statistics.payments(callback)
    • statistics.sales(options, callback)
    • statistics.detailedSales(options, callback)
  • Карта цен
    • map.directions(options, callback)
    • map.prices(options, callback)
  • Направления
    • directions.airline(options, callback)
    • directions.city(options, callback)
  • Разное
    • whereami(options, callback)
    • currency(callback)
• Пример
• Тесты
• Лицензия

Установка

npm i travelpayouts

Использование

1. Зарегистрируйтесь на Travelpayouts.
2. В разделе Разработчикам → API получите API токен.
3. В своем коде подключите библиотеку и передайте ей токен следующим образом:

var travelpayoutsAPI = require('travelpayouts');
var tapi = travelpayoutsAPI({ token: 'ваш_токен' });

Теперь вы можете использовать методы API.

API

travelpayoutsAPI([options])

Функция, возвращающая объект API, принимает объект со следующими параметрами:

• token — API токен, обязательный параметр, если вы собираетесь работать с API, закрытыми токеном.

• marker — партнерский маркер, обязательный параметр, если вы собираетесь работать с API поиска авиабилетов.

• host — название вашего сайта или приложения, обязательный параметр, если вы собираетесь работать с API поиска авиабилетов.

• requestOptions — опции модуля request, которые будут использованы по умолчанию. Используйте, если хотите поменять таймаут по умолчанию, использовать прокси и т.д.

Все методы

Все параметры запроса, если необходимы, передаются внутри объекта, идущего первым аргументом. Все методы принимают в качестве одного из аргументов callback, который будет вызван с результатами выполнения запроса. Первым аргументом в callback всегда передается ошибка или null, если ошибок не было.

Для каждого метода ниже дается ссылка на релевантную часть официальной документации.

Обратите внимание, что токен, маркер и хост всегда, где необходимо, передаются автоматически и вам это делать не нужно!

Цены

Позволяет получать разнообразные данные из кэша поиска авиабилетов.

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

prices.latest(options, callback)

Цены на авиабилеты за 48 часов

prices.monthMatrix(options, callback)

Календарь цен на месяц

prices.weekMatrix(options, callback)

Календарь цен на неделю

prices.nearestPlacesMatrix(options, callback)

Цены по альтернативным направлениям

prices.cheap(options, callback)

Самые дешевые авиабилеты

prices.monthly(options, callback)

Самые дешевые авиабилеты по месяцам

prices.direct(options, callback)

Билеты без пересадок

prices.calendar(options, callback)

Билеты из города на любое число месяца

prices.holidaysByRoutes(options, callback)

Самые дешевые билеты на выходные

minPricesCalendar(options, callback)

Календарь цен

specialOffers(callback)

Специальные предложения

Несмотря на то, что API возвращает XML, на выходе модуля вы получаете уже готовый JS-объект.

Поиск авиабилетов

Условия предоставления доступа к API поиска билетов

Обратите внимание, что подпись (md5 signature) формируется модулем автоматически на основе переданных параметров, и вам это делать не нужно.

flight.search(params, callback)

Инициализация поиска

flight.results(params, callback)

Получение результатов поиска

flight.click(params, callback)

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

Партнерская статистика

statistics.balance(callback)

Баланс

statistics.payments(callback)

Выплаты партнерского вознаграждения

statistics.sales(options, callback)

Данные по переходам и покупкам

statistics.detailedSales(options, callback)

Данные по дате и доп. маркеру

Карта цен

map.directions(options, callback)

Поддерживаемые направления

map.prices(options, callback)

Цены

Направления

directions.airline(options, callback)

Популярные направления авиакомпании

directions.city(options, callback)

Популярные направления из города

Разное

whereami(options, callback)

Определение местоположения пользователя по IP-адресу

Указывать callback среди других параметров не нужно, так как это делает модуль автоматически.

currency(callback)

Текущий курс популярных валют к рублю

Пример

var travelpayoutsAPI = require('travelpayouts');
var tapi = travelpayoutsAPI({ token: 'ваш_токен' });

tapi.prices.latest({
    currency: 'rub',
    period_type: 'year',
    page: 1,
    limit: 30,
    show_to_affiliates: true,
    sorting: 'price',
    trip_class: 0
}, function (err, result) {
    if (err) throw err;
    console.log(result);
});

Тесты

Для запуска тестов нужно склонировать данный репозиторий, выполнить npm install и запустить npm test. Будет выполнен тест модуля на тестовых данных.

Чтобы запустить тест против настоящего API, например, для проверки совместимости модуля с текущим API, используйте команду

mocha --reporter=spec -t 10000 -s 10000 tests/test.api.js --token ваш_токен

Лицензия

The MIT License (MIT)

Copyright (c) 2016 Alexey Komarov alex7kom@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.