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 & Venue

Your brand identifier and venue ID
Don’t have credentials yet? Contact [email protected] to get started.

​
Step 1: Authenticate

First, obtain an access token by calling the authentication endpoint: 
curl -X POST https://integrations.clopos.com/open-api/auth \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "{{client_id}}",
    "client_secret": "{{client_secret}}",
    "brand": "{{brand}}",
    "venue_id": "{{venue_id}}"
  }'
You’ll receive a response like this: 
{
  "success": true,
  "token": "oauth_ZH5YQZp1mN987w0fI6HfONisbrF1GX3wujdjIQRT4Eo7rSq7ZbE0GfGyjIw0vOUP",
  "token_type": "Bearer",
  "expires_in": 3600,
  "message": "Authentication successful"
}
Save the token value - you’ll need it for all subsequent API requests. Tokens expire after 1 hour.

​
Step 2: Make Your First Request

Now let’s fetch the list of products using your access token with the required headers: 
curl -X GET "https://integrations.clopos.com/open-api/products?limit=5" \
  -H "x-token: oauth_ZH5YQZp1mN987w0fI6HfONisbrF1GX3wujdjIQRT4Eo7rSq7ZbE0GfGyjIw0vOUP" \
  -H "x-brand: openapitest" \
  -H "x-venue: 1"
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

Create Receipt

Generate receipts

​
Next Steps

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