An API key is used to connect a 3rd party system with your specific ForeFlight Dispatch account. The API Console page in Dispatch allows you to generate new API keys and view the history of requests made through existing APIs. API keys should be kept confidential as they allow full access to your ForeFlight data through the Dispatch API.
1. Generating API Keys
On the API Keys tab, you can generate an API key for integration with an existing 3rd party product or access the documentation to build your own integration.
The API Keys page also displays a record of when API keys have been created including the user it was created by, date and time generated, the API key, and current status (Active or Revoked).
Click the “Generate Key” button in the top right-hand corner to generate a new API key. You can also filter the list of previously-generated keys using the Created At, Last Used, and Only Active fields.
|IMPORTANT: After generating a key make sure to save it. Keys are not shown again and cannot be retrieved once generated. If you believe that the security of an API key has been compromised you should immediately revoke it and generate a new one to prevent unauthorized access.|
2. Flight Schedule API
The Flight Schedule API allows for easy import of flights into Dispatch from your flight scheduling system. Flights can be imported on a one-by-one basis or as a batch. You can keep updating flights through the scheduling API as your schedule changes.
View a list of currently-supported scheduling integrations here.
3. Flights API
The Flights API allows for more fine-grained interaction with the Dispatch system, allowing you to create flights with more detailed data, retrieve fuel burn and times for those flights as well as briefing and navlog. You can also run ad-hoc performance calculations for already setup aircraft as well as generic aircraft. The quotation API is a simplified performance API that will estimate time, fuel burn using fewer parameters and a rough routing approximation.
4. Request History
The Request History tab stores and displays the most recent API requests made using any API key associated with your ForeFlight account. Use this tool to identify how and when your third party applications are interacting with your ForeFlight account.
The table is automatically sorted by the request date such that the most recent requests will be at the top of the table. The Request Path matches to an API operation, which will tell you what action was attempted. For instance, public/api/schedule/flights and public/api/flights are responsible for creating new flights externally.
The request and response JSON links will download text files that will give more detail about the action that was attempted and the result. The HTTP status code will show the presence of any major errors, though less severe warnings, such as mismatched aircraft or crew, will only be present in the Response JSON.
If you believe there is a problem with one or more of your API integrations, contact ForeFlight’s Customer Success team at firstname.lastname@example.org for help using these files and diagnosing the problem.