​

Welcome to Clopos Open API

​

What you can do with the Clopos API

​

Base URL

https://integrations.clopos.com/open-api

​

API Version

​

Getting Started

​

1. Collect your credentials

• Request an integrator_id from Clopos by filling out this form. This one identifier is issued by Clopos and reused across every brand you connect to.
• Get the client_id, client_secret, and brand from the Clopos customer you are integrating with. They generate the pair themselves in their back office under Add-ons → Open API — see Authentication for the steps to send them.
• Store all four credentials securely; never commit secrets to source control.

​

2. Authenticate against v2

• Send a POST request to https://integrations.clopos.com/open-api/v2/auth with your credentials:
  {
    "client_id": "your_client_id",
    "client_secret": "your_client_secret",
    "brand": "your_brand",
    "integrator_id": "your_integrator_id"
  }
  
• On success, you receive a JWT:
  {
    "success": true,
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 3600,
    "expires_at": 1767852332,
    "message": "Authentication successful"
  }
  
• Tokens expire after expires_in seconds. Refresh them before they expire to avoid request failures.

​

3. Call your first endpoint

• Include the JWT in the x-token header. brand, venue_id, and integrator_id are encoded in the token, so no additional headers are needed.
• Example cURL request to list products:
  curl -X GET "https://integrations.clopos.com/open-api/v2/products" \
    -H "x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  
• You can filter by product type, category, tags, and many more fields.

​

4. Explore the API surface

• Browse the Quickstart guide for a scripted example.
• See the Authentication reference for header requirements and helpers.
• Dive into the API reference or jump directly to key endpoints like List Products.