Register Your Project
The Firehouse Solutions API gives your developers read-only access to your website's data (news, calendar events, training records, member rosters, custom databases, and more) as JSON over HTTPS. Before any API calls can be made, you must register an API Project in the Members Area. Each project receives its own refresh token and its own settings, so create one project per application (for example, one for a display board and another for a mobile app) so each can be monitored and revoked independently.
Before You Begin
- The API must be activated for your website by the Firehouse Solutions team. If you do not see the API option in the Members Area, contact Support@FirehouseSolutions.com to request activation.
- You must be logged in as a website manager to create or manage API Projects.
Create a New Project
- Log into the Members Area of your website.
- Navigate to Website Management > Application Programming Interface (API).
- Click New Project.
- Enter a name for your project. Use a name that describes the application that will use it (for example, "Station 1 Display Board").
- Press Submit Project.
Submitting the project generates an OAuth2 Refresh Token. Give this token to your developer; it is used to request Access Tokens, which are then sent with every data request.
Tokens and Expiration
- Refresh Token – created with your project and valid for 1 year. Keep it secret and treat it like a password. When it expires, regenerate it from the API Project page.
- Access Token – obtained by sending the refresh token to the refresh endpoint and valid for 1 day (24 hours). When it expires, simply request a new one with your refresh token.
Project Settings
Each API Project has its own settings that can be adjusted at any time:
- Status – enable or disable the project without deleting it.
- Endpoint Access – limit the project to only the data endpoints it needs.
- IP Address Lockdown – list the IP addresses allowed to use the project; all other addresses are refused.
- Regenerate Token – issue a new refresh token at any time. All active access tokens for the project are revoked immediately.
- Statistics – view call volume, throttle consumption, and a log of every call (including failures) for the past 90 days.
Usage Limits
Each project is limited to 30 calls per minute and 5,000 calls per day. Passwords and account credentials are never available through the API, and nothing can be created, changed, or deleted through it.
For endpoint details, request and response samples, and error codes, see the
API Documentation.