¶ Ready to get going?
The first thing you will need (if you are working with the REST API) is a Personal Access Token.
A PAT acts as an alternative username & password system, giving anyone who has it access to operate your account on your behalf.
It's extremely important that you keep your PAT secret and secure, as it gives FULL access to your PERSONAL account.
FsHub caries no responsibility if you accidentally leak your token!
We recommend you 'rotate' your PATs in your applications every few months. Check out our Security Practices article for more tips on keeping your account & your application secure.
¶ Creating a Personal Access Token
- Go to the FsHub Settings page
- Locate the the "Integrations" section
In this area you can view your personal access token or generate a new one using the Generate new token (1) button:
You can hover on an API key or clicking the Copy button to copy your Personal Access Token.
You can use your Personal Access Token to access VA endpoints as well.
¶ Can I use my PAT on a Virtual Airline?
Yes you can! You will need to have the right permissions in a Virtual Airline to manage it via the API.
💡 Refer to the Roles & Permissions documentation for more details about VA permissions.
You can also create a Virtual Airline only PAT, simple go to the Virtual Airline Pilot Crew Portal area, visit the integrations page and follow the same steps as making a Personal token.
If you are application only requires access to a specific VA, a VA PAT is recommended than creating a PAT on your personal account.
¶ Software Development Kits
Now it's time to interact with the API! There are currently two ways to do this:
A) You can perform simple HTTP REST requests to the relevant API endpoints, and receive (or set) data, or
B) Use an SDK made by us, or the community
We recommend using an SDK when possible, as typically they will be up to date to the latest API endpoints, which means you will not have to dig our documentation or thorougly test the API to make sure your app works.
The following is a list of API clients that are designed to help you integrate data and services from our platform into your own website, applications and/or services as quickly and easily as possible.
| Name | Language | Documentation | Link | Author |
|---|---|---|---|---|
| .NETSDK | .NET | Included | Download | Bobby Allen |
| PHPSDK | PHP | Included | Download | Bobby Allen |
If you are developing an API client library or SDK for another language or framework, please let us know and we'll update this list!
💡 Don't forget to read the REST API and Webhooks documentation too!