Authentication

To get started with the XONE API, you'll first need to obtain an access token. This token acts as a digital key, granting your application permission to make API calls.

This process uses the OAuth 2.0 Client Credentials Grant flow. You'll use your unique client ID and client secret to request a token, which you then include in subsequent API requests.

🔑 Authentication Steps

• Request Token: Send a "Retrieve Token" request to the XONE authorization server's token endpoint.

• Include Credentials: In the request body, provide your client_id and client_secret as a JSON object.

• Use Token: The server will respond with an access_token that you can now use to authenticate your API calls by including it in the Authorization header as a Bearer token.

Retrieve token

post

Body

application/json

grant_typestringRequired

client_idstringRequired

client_secretstringRequired

Responses

200

200 OK

application/json

401

401 Unauthorized

application/json

post

/api/oauth/token

HTTPcURLJavaScriptPython

POST /api/oauth/token HTTP/1.1
Host: api.xone.xcover.com
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "grant_type": "text",
  "client_id": "text",
  "client_secret": "text"
}

{
  "token_type": "text",
  "expires_in": 1,
  "access_token": "text"
}