¶ FsHub Developer Documentation
¶ The REST API
The FsHub REST API is used interacting with the website programmatically. For example if you would like to fetch or edit data on your account or your VA, using the REST API is your way to go.
💡 Click here to learn more about the REST API.
¶ The Webhooks API
On the otherhand, if you are looking on receiving data on your own servers from FsHub for various events (such as a flight being completed) you can use the Webhook API.
💡 You can learn more about the Webhooks here!
¶ The Streaming API
A real-time (socket) streaming API will be available in addition to our existing REST and webhook APIs very soon!
¶ API clients and libraries
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.
- .NET SDK - The official FsHub .NET SDK by Bobby Allen
- PHP SDK - The official FsHub PHP SDK by 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!
¶ Service Status API
This section is currently not up to date. The status of fshub.io is not monitored with statuspal anymore.
If you are consuming any of the above FsHub APIs you may additionally wish to monitor the platform status and programmatically handle outage events as part of your software integrations.
Whilst we keep outages to an absolute minimum, we do provide a "human readable" Service Status page but you can also make a HTTP GET request to https://statuspal.io/api/v1/status_pages/fshub/status and retrieve our current service status in JSON format.
Please note that our status page is externally hosted by StatusPal and as such, we do not maintain these endpoints but offer them to software developers as a way of adding additional enhancements. You can read more about the schema and status page API documentation on the StatusPal website.
¶ Fetching your FsHub Access Token
Go to the FsHub Settings page and locate the the "Integrations" page. 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.
Always keep your Personal Access Token secure. Accidentally leaking your access token grants everyone access to your account! Click here for various security practices. FsHub caries no responsibility if you accidentally leak your token!
¶ For Virtual Airlines usage
You can use your Personal Access Token to access VA endpoints as well.
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.