Auth
Authorize
Authenticate with the Integrations API using OAuth 2.0.
POST
The Integrations API uses OAuth 2.0 (RFC 6749) with the client credentials grant for server-to-server authentication.
Prerequisites
Register your integration in the Fire spark dashboard to obtain aclient_id and client_secret. Store the client secret on your server only.
Client credentials grant
Use this grant for machine-to-machine integrations such as POS, RMS, and aggregator connectors. Request an access token directly from the token endpoint.Token request parameters
| Parameter | Required | Description |
|---|---|---|
grant_type | Yes | Must be client_credentials. |
client_id | Yes | Your integration client ID. |
client_secret | Yes | Your integration client secret. |
scope | No | Space-delimited list of scopes. Defaults to the scopes configured for your integration. |
Available scopes
| Scope | Access |
|---|---|
menus:read | Read menus, categories, and products |
menus:write | Create and update menus |
stores:read | Read store configuration |
stores:write | Update store configuration |
channels:read | Read sales channels |
channels:write | Update sales channels |
orders:read | Read orders |
orders:write | Create and update orders |
fulfillment:read | Read fulfillment options |
fulfillment:write | Update fulfillment options |
Use the access token
Include the access token in theAuthorization header of every authenticated request.
Error responses
Token and authorization errors follow RFC 6749. The token endpoint returnsapplication/json with an error field.
| Error | Description |
|---|---|
invalid_request | A required parameter is missing or malformed. |
invalid_client | Client authentication failed. |
invalid_grant | The provided credentials are invalid. |
unauthorized_client | The client is not authorized for this grant type. |
unsupported_grant_type | The grant_type value is not supported. |
invalid_scope | The requested scope is invalid or exceeds what is allowed. |
Error