API Access

There is an API for read-only access to bookings and aircraft booked out.

You might find API access useful if you need to extend the system for yourself. For example:

  • Automatically send an email to staff near the end of the day if there are any out of hours flights booked. This could be used to make sure the aircraft keys are left out instead of being locked up.
  • Show today's bookings on a screen in the office. You should consider whether to expose member's names to other people (the system hides other member names unless they have opted in to being contacted).

 

You can request an API token at Admin > Basic Settings and then in the Advanced section.

Authentication

The API uses simple authentication, where requests are made in the context of an office staff user. The token is per site rather than per user, which means it can be set up once and it does not depend on staff leaving the business. The token is a long string which looks something like "fb1f233e08aeef0a213dc87cea70cedbd7dbcd0a2229cac4f64e14e3c462cc8e".

When making a request, include an authorisation header containing your token, for example:

curl -H "Accept: application/json" -H "Authorization: Bearer fb1f233e08aeef0a213dc87cea70cedbd7dbcd0a2229cac4f64e14e3c462cc8e" https://acme.flightschoolbooking.com/club/bookings

Parameters

Parameters can be sent in the query string, e.g.

https://acme.flightschoolbooking.com/club/bookings?page=0

Response format

Responses are returned in JSON.