TABLE OF CONTENTS
- What is the Flight Crew View Logbook API?
- How Does It Work?
- What Info Is Shared?
- How does OAuth 2.0 work?
- How to Create Your Logbook API Client Account and Request Access
- I don't have an app, can I get access?
What is the Flight Crew View Logbook API?
The Flight Crew View Logbook API allows developers to access and sync flight data for Flight Crew View users. This API enables integration with third-party logbook applications, helping pilots and flight attendants maintain accurate and up-to-date records of their flights.
How Does It Work?
The Flight Crew View Logbook API uses OAuth 2.0 for secure authentication and authorization. OAuth 2.0 is an industry-standard protocol that allows applications to obtain limited access to user accounts on an HTTP service. It works by delegating user authentication to us. We'll make sure that the user has authorized access, and then we'll authorize your third-party application to access only that user account's flight history.
What Info Is Shared?
Flight Crew View does not share any information to 3rd party logbook applications without the Flight Crew View user's explicit permission to grant authorization to your application. Once granted, Flight Crew View will allow access to just that user's flight history and future flights and the flight deck crew (pilots) that are on those flights.
How does OAuth 2.0 work?
You will need access to a secure backend server to access the API and store Access and Refresh Tokens. This OAuth 2.0 flow, the tokens, and all requests to the API should be done through your backend server. They should never be done through your client app.
- Authorization Request: The third-party logbook application (client) requests authorization from the user.
- Authorization Grant: The user authorizes the request (via Flight Crew View) and the client logbook server receives an authorization code.
- Access Token Request: The client logbook server requests an access token from the authorization server (Flight Crew View) by presenting the authorization code.
- Access Token Response: The authorization server authenticates the logbook server and issues an access token.
- Access Resource: The logbook server uses the access token to request resources (flight data) from the resource server (Flight Crew View).
Much more detailed info and steps are included in the Logbook API Client Portal once access is granted.
How to Create Your Logbook API Client Account and Request Access
To get started with the Flight Crew View Logbook API, follow these steps:
Create Your Logbook API Client Account:
- Visit the Flight Crew View Logbook API Client Portal.
- Log in with your Flight Crew View account credentials or create a new account.
- Flight Crew/Hobbyists that wish to access their own account: It's important that you log into the Logbook API Client Portal and request access under your own Flight Crew View app account email. Hobbyists are limited to only accessing their own flights.
- Fill out the API access request form with details about your application, including the app name, description, developer name, and other relevant information.
Request Access:
- IMPORTANT: Ensure you have reviewed and agreed to the Flight Crew View Logbook API Privacy Policy and Terms and Conditions. There are restrictions in those documents that you must adhere to when using the API.
- Submit the access request form. Your request will be reviewed, and you will be notified via email about the status of your request.
- If approved, you will receive further instructions on how to integrate the API with your application.
I don't have an app, can I get access?
Yes! The API has 3 tiers of access for developers:
- Hobbyists: Available to anybody that runs their own secure server.
- Tight rate limits and the hobbyist will only be able to authorize access to their own schedule.
- Indie: Available to smaller/growing applications.
- Must have a publicly-available application with a secure backend server, privacy policy, and terms & conditions.
- Slightly higher rate limits, but able to request authorization to other's accounts.
- Established: Available to larger, more established and recognized logbook applications.
- Higher rate limits and and able to request authorization to other's accounts.
The Flight Crew View Logbook API provides a powerful tool for developers looking to create or enhance logbook applications. By using this API, you can ensure that your users have access to the most accurate and up-to-date flight data available.
For any questions or additional support, please contact us at [email protected].