Fareclock API requests are authenticated with an API key sent in the Authorization header as Token YOUR_API_KEY. Every request must include a valid key, and you can create separate keys with scoped permissions for different integrations.

The Fareclock API uses HTTP access authentication to authenticate each request. Multiple API keys can be created per account to support application isolation. The API keys are set up and managed in the Fareclock Admin Console application.

The API key establishes authentication using an HTTP header, as follows:

Authorization: Token MY_API_KEY

To create an API key, sign in to https://www.fareclock.com/login. Then in the top menu bar, go to Settings => Integrations. On the screen below the menu bar, you can add an API key, or edit any existing ones. You can also set specific permissions for an API key.

FAQ

Where do I put the Fareclock API key?

Send it in the Authorization header using the Token scheme.

Authorization: Token YOUR_API_KEY

Can I create more than one API key?

Yes. Fareclock supports multiple API keys per account, which is useful for separating applications and limiting permissions by integration.

What response should I expect if authentication fails?

Authentication failures typically return HTTP 401 Unauthorized. If a key is valid but does not have permission for a resource, the API may return HTTP 403 Forbidden.