Skip to main content

Authentication

This documentation describes how to authenticate your application with Keycloak to obtain an access token, which is required to consume the APIs of our systems.

🔐 Access Information​

During the integration setup, the technical team will provide the following credentials:

  • Keycloak Host
  • Realm
  • Client ID
  • Client Secret

Available Environments​

🔧 Stage/RC​

The staging environment is available with separate realms for each region:

RegionRealmHost (Stage/RC)
Europestage1-euhttps://keycloak.stag.bolttechbroker.net
Asiastage1-ashttps://keycloak.stag.bolttechbroker.net
RC Europerc-euhttps://keycloak.stag.bolttechbroker.net
RC Asiarc-ashttps://keycloak.stag.bolttechbroker.net

🚀 Production​

RegionRealmHost (Production)
Europe
Asia

🧾 How to Obtain the Token​

To authenticate and get an access token, send a POST request to the Keycloak token endpoint:

Endpoint​

POST {host}/realms/{realm}/protocol/openid-connect/token

Headers​

Content-Type: application/x-www-form-urlencoded

Request Body (application/x-www-form-urlencoded)​

client_id={CLIENT_ID}
client_secret={CLIENT_SECRET}
grant_type=client_credentials
scope=openid

Request Example (cURL)​

curl -X POST https://keycloak-stage.example.com/realms/stage-eu/protocol/openid-connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "client_id=my-client" \
  -d "client_secret=my-client-secret" \
  -d "grant_type=client_credentials" \
  -d "scope=openid"

📦 Expected Response​

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 300,
  "token_type": "Bearer",
  "scope": "openid"
}
  • access_token: Access token to be used in API calls.
  • expires_in: Time (in seconds) until the token expires.
  • token_type: Token type (always Bearer).
  • scope: Token scopes, if applicable.

🚀 How to Use the Token with APIs​

After obtaining the access_token, include it in the Authorization header of your API requests.

API Request Example with Token​

GET /api/example HTTP/1.1
Host: api.example.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

❗ Important​

  • The token expires after a set time. You must request a new one after expiration.
  • The stage/RC environment is for testing and staging only.
  • Keep the provided credentials secure and do not expose them in public clients (e.g., browsers or mobile apps).

For technical support, please contact the integration team.