Authentication
All Updates API requests require a short-lived access token. The validity periods for the long-lived and short-lived tokens are configurable to suit your security requirements.
The Updates API uses a two-step authentication flow:
- Create an integration consumer in the Jomablue portal and generate a long-lived token.
- Exchange that long-lived token for a short-lived access token, then send the short-lived token on your Updates API requests.
You can create multiple consumers, each with a limited scope, and multiple access tokens per consumer. For example, one consumer might be your CRM or marketing system, while another consumer (such as an onsite activation or a third party) is granted a narrower scope of data access.
Token rotation is supported.
Endpoint
POST https://your-instance.jomablue.com/integration/api/auth
Send your long-lived token as the Bearer token. The response returns a short-lived access token in the data field.
Headers
Include these headers on all requests:
- Authorization: Bearer <token>
- Accept: application/json
When sending a JSON body (such as the auth request), also include:
- Content-Type: application/json
Send an appropriate User-Agent so Jomablue can identify requests originating from your systems.
Examples
Step 1: Request a short-lived token
Send your long-lived token in the Authorization header:
curl --request POST \
--url https://your-instance.jomablue.com/integration/api/auth \
--header 'Authorization: Bearer <long-lived-token>' \
--header 'User-Agent: your-system-name' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'The short-lived access token is returned in the data field:
{
"success": true,
"data": "<short-lived-token>",
"included": []
}Step 2: Use the token on Updates API requests
Take the value from data and send it as the Bearer token on your Updates API resource requests. Do not send your long-lived token to these endpoints.
curl --request GET \
--url https://your-instance.jomablue.com/updates/api/{endpoint-uuid}/event-people \
--header 'Authorization: Bearer <short-lived-token>' \
--header 'User-Agent: your-system-name' \
--header 'Accept: application/json'When the short-lived token expires, request a new one from the auth endpoint using your long-lived token.