Skip to main content

​
Quick Start Guide

Get started with the Clopos Open API in just a few simple steps. This guide will walk you through authentication and making your first API request.

​
Prerequisites

Before you begin, make sure you have:

API Credentials

Client ID and Client Secret from Clopos

Brand

Your brand identifier

Integrator ID

Required for v2 authentication. Request one from Clopos via this form.

Support

Missing any of the above? Request access via this form.

​
Step 1: Authenticate

Exchange your credentials for a JWT by calling the v2 auth endpoint. Note that v2 requires an integrator_id and no longer accepts venue_id in the request body. 
curl -X POST https://integrations.clopos.com/open-api/v2/auth \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "{{client_id}}",
    "client_secret": "{{client_secret}}",
    "brand": "{{brand}}",
    "integrator_id": "{{integrator_id}}"
  }'
You’ll receive a response like this: 
{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "expires_at": 1767852332,
  "message": "Authentication successful"
}
Save the token value — you’ll need it in the x-token header on every subsequent request. The token is a JWT that encodes your brand, venue_id, and integrator_id, so you no longer need to send x-brand or x-venue. Tokens expire after expires_in seconds (typically 1 hour).
Don’t have an integrator_id yet? Request one from Clopos by filling out this form. See the Authenticate reference for details.

​
Step 2: Make Your First Request

Now let’s fetch the list of products using your access token: 
curl -X GET "https://integrations.clopos.com/open-api/v2/products?limit=5" \
  -H "x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
You’ll receive a response with your products: 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Coffee",
      "price": "4.50",
      "status": 1,
      "category_id": 3
    },
    {
      "id": 2,
      "name": "Sandwich",
      "price": "8.99",
      "status": 1,
      "category_id": 5
    }
  ],
  "total": 150,
  "time": 45
}

​
Step 3: Explore More Endpoints

Now that you’re authenticated, you can explore other endpoints:

Get Categories

Fetch product categories

Create Order

Place a new order

Get Customers

Retrieve customer data

List Receipts

Browse open and closed receipts

​
Next Steps

You’re now ready to build amazing applications with the Clopos Open API! 🚀