Generate access token - Clopos Open API

POST

/

auth

Generate access token

curl --request POST \
  --url https://integrations.clopos.com/open-api/v2/auth \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "your_client_id_here",
  "client_secret": "your_client_secret_here",
  "brand": "your_brand",
  "integrator_id": "your_integrator_id_here"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_id: 'your_client_id_here',
    client_secret: 'your_client_secret_here',
    brand: 'your_brand',
    integrator_id: 'your_integrator_id_here'
  })
};

fetch('https://integrations.clopos.com/open-api/v2/auth', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.clopos.com/open-api/v2/auth"

payload = {
    "client_id": "your_client_id_here",
    "client_secret": "your_client_secret_here",
    "brand": "your_brand",
    "integrator_id": "your_integrator_id_here"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "expires_at": 1767852332,
  "message": "Authentication successful"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

Body

application/json

API credentials

client_id

string

required

Your client ID issued by Clopos

Example:

"your_client_id_here"

client_secret

string

required

Secret paired with the client

Example:

"your_client_secret_here"

brand

string

required

Brand identifier

Example:

"your_brand"

integrator_id

string

required

Integrator ID. New in v2 — identifies the integrator making the request. Request one via https://forms.gle/Y9P1Wnv4QFAruxny8

Example:

"your_integrator_id_here"

Response

Token generated successfully

success

boolean

Example:

true

token

string

JWT access token for API requests

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

token_type

string

Token type

Example:

"Bearer"

expires_in

integer

Token expiration time in seconds

Example:

3600

expires_at

integer

Unix timestamp when the token becomes invalid

Example:

1767852332

message

string

Example:

"Authentication successful"

Generate access token

curl --request POST \
  --url https://integrations.clopos.com/open-api/v2/auth \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "your_client_id_here",
  "client_secret": "your_client_secret_here",
  "brand": "your_brand",
  "integrator_id": "your_integrator_id_here"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_id: 'your_client_id_here',
    client_secret: 'your_client_secret_here',
    brand: 'your_brand',
    integrator_id: 'your_integrator_id_here'
  })
};

fetch('https://integrations.clopos.com/open-api/v2/auth', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.clopos.com/open-api/v2/auth"

payload = {
    "client_id": "your_client_id_here",
    "client_secret": "your_client_secret_here",
    "brand": "your_brand",
    "integrator_id": "your_integrator_id_here"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "expires_at": 1767852332,
  "message": "Authentication successful"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}