Skip to main content
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 a client_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

Available scopes

Use the access token

Include the access token in the Authorization header of every authenticated request.
Access tokens expire after the number of seconds indicated by expires_in. Request a new token before expiry. Do not expose client secrets or access tokens in client-side code.

Error responses

Token and authorization errors follow RFC 6749. The token endpoint returns application/json with an error field.
Error

Body

application/x-www-form-urlencoded
grant_type
enum<string>
required
Available options:
client_credentials
client_id
string
required
client_secret
string
required
scope
string

Space-delimited scopes such as menus:write stores:read orders:read.

Response

200 - application/json

Ok

data
object