Get Access Token

Use this endpoint with your API key to get an access token, which is essential for authenticating other API requests.

Endpoint Details

GET /authentication

If you need assistance on obtaining your API key, contact support

Headers

Header	Value
Content-Type	application/json
X-LIQUID-API-KEY	<YOUR_API_KEY>

Response Details

Field	Type	Description
statusCode	number	Internal status code of the response
message	string	A brief message describing the result of the API call
metadata	metaDataObject	Contains metadata about the API call
data	authObject	Authentication object

Metadata Object

Field	Type	Description
languages	Array<string>	List of supported languages for the response, e.g. ["en"]
timestamp	string	Unix timestamp (in milliseconds) when the response was generated
timezone	string	Timezone used for the response, always "UTC"
requestId	string	Unique identifier for the API request. Used for debugging and support
path	string	API path
version	string	API version used for the request

Auth Object

Field	Type	Description
token	string	The access token to be used for other API calls
type	string enum	The type of token, always "ACCESS_TOKEN"
exp	number	The expiration timestamp of the token (1 day)

Sample Request and Response

curl --location 'https://api.liquidcommerce.cloud/authentication'

201

{
    "statusCode": 200,
    "message": "OK",
    "metadata": {
        "languages": [
            "en"
        ],
        "timestamp": 1731590739955,
        "timezone": "UTC",
        "requestId": "reqid_123abc45def",
        "path": "/api/authentication",
        "version": "1.7.0"
    },
    "data": {
        "token": "<YOUR_ACCESS_TOKEN>",
        "type": "ACCESS_TOKEN",
        "exp": 1731674132795
    }
}

400

Using the Access Token

After obtaining the access token, include it in the Authorization header on any API calls to LiquidCommerce API Services.

Authorization: Bearer <YOUR_ACCESS_TOKEN>

Access Token Refresh

All API endpoints that require authentication now support token refreshing. This is done by including a refresh parameter in the request body.

Request Body Parameter

Parameter	Type	Description
refresh	boolean	When set to true, a new access token will be generated and returned

Response

When refresh is set to true, the API response will include an auth object containing the new access token information.

{
    "auth": {
        "token": "<NEW_ACCESS_TOKEN>",
        "type": "ACCESS_TOKEN",
        "exp": 1722920383204
    },
    // ... other response data
}

Error Handling

The API uses standard HTTP response codes to indicate the success or failure of requests. In case of an error, the response body will contain a JSON object with more details about the error.

Rate Limiting

The Authentication API is subject to rate limiting to ensure fair usage and maintain performance. If you exceed the rate limit, you'll receive a 429 (Too Many Requests) response.

Best Practices

• Store the access token securely on the client-side.

• Include the refresh parameter when making requests close to the token's expiration time.

• Update the stored access token whenever a new one is received in the auth object of a response.

• Implement proper error handling for cases where token refresh fails.

Support

Our dedicated support team is available to assist you with API integration and usage. For any questions or issues, please contact [email protected].