node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

yepjet

yepjet-js

Welcome to the JavaScript SDK for YepJet, the simple flight booking API.

Install

npm i yepjet

API

The library is structured as to mimic the REST APIs. There are 5 resources currently available. Methods are available under yepjet.${resource}.${method}. Every method issues an HTTP request and returns a Promises/A+ specification.

The YepJet client is obtained this way var yepjet = require('yepjet')('apiKey');. The API key is not necessary so far, since we are in beta and all the endpoints are public, via the https://sandbox.yepjet.com/v1 url.

Search

The entry point to the REST APi. Allow searching of multiple flights and passengers.

Path: /search

Method: yepjet.search(params)

Params:

{
  flights: [
    {
      from: 'SFO', // 3-LETTER IATA CODE 
      to: 'JFK', // 3-LETTER IATA CODE 
      departure: "2016-01-01" // yyyy/MM/dd FORMATTED DATE 
    }
  ],
  passengers: [{ category: 'ADT' }] 
}

Flights

Provides details about the selected flights.

Path: /flights/:id

Method: yepjet.flights.fetch(flightId)

Orders

A cart-like structure which holds the selected flights, ready for purchase.

Path: /orders

Method: yepjet.orders.create(params)

Params:

{
  flights: [{ id: 'xxxx-xxxx-xxxxxxxxx' }] // ARRAY OF FLIGHT IDS 
}

Path: /orders/:ordersId/flights/:flightId

Method: yepjet.orders.addFlight(orderId, flightId)

Traveler

Allows creation and retrieval of travelers, which include payment details and ticket-specific properties.

Path: /travelers

Method: yepjet.travelers.create(params)

Params:

{
  prefix: 'Mr.',
  first_name: 'Jon',
  last_name: 'Snow',
  gender: 'M',
  email: 'you@knownothing.com',
  birth_date: "1990/10/10",
  phone_number: '0123456789',
  address: {
    street: 'Tower A',
    city: 'The Wall',
    state: 'North',
    postal_code: '12345',
    country: 'GB'
  }
}

Path: /travelers/:id

Method: yepjet.travelers.fetch(travelerId)

Bookings

The final booking call, which allows to book the selected itinerary through a previously created order

Path: /bookings

Method: yepjet.bookings.create(params)

Params:

{
  order_id: 'xxxx-xxxx-xxxxxxxxx', // ID OF THE SELECTED ORDER 
  payment_token: 'xxxx-xxxx-xxxxxxxxx', // ID OF THE SELECTED PAYMENT METHOD 
  travelers: [{ id: 'xxxx-xxxx-xxxxxxxxx' }] // ARRAY OF TRAVELERS BY ID 
}

Contributing

We support and encourage contributions, be it through issues or pull requests. In case you'd like to submit a patch, please do as follows:

  • Open a PR in a branch with a significant name
  • Submit PR
  • If necessary, complement with unit tests

Thanks a lot!

License

MIT