Skip to main content

​
Welcome to Clopos Open API

The Clopos Open API provides secure and unified access to the Clopos ecosystem, enabling seamless integration of POS, ordering, payments, and restaurant management services.

Quick Start

Get up and running with the Clopos API in minutes

Authentication

Learn how to authenticate and secure your API requests

API Reference

Explore all available endpoints and their usage

Support

Get help from our development team

​
What you can do with the Clopos API

Use OAuth 2.0 tokens scoped to specific brands and venues for secure access to your data.
Access and manage products, menus, orders, receipts, payments, and customers with comprehensive CRUD operations.
Built-in pagination, filtering, and sorting capabilities across all endpoints for efficient data retrieval.
Streamline order synchronization, payment reconciliation, and reporting processes.
Build custom dashboards, delivery integrations, and mobile applications on top of our platform.

​
Base URL

All API requests should be made to: 
https://integrations.clopos.com/open-api

​
API Version

Current API version: 1.0.1

​
Getting Started

Follow these steps to go from zero to a working integration:

​
1. Request access credentials

  • Reach out to [email protected] or your Clopos account manager to request API access.
  • Receive the following sandbox credentials:
    • brand (openapitest)
    • venue_id (1)
    • client_id (6553676e0d265ac837e8f79fc)
    • client_secret (seCyF_4vja6yddQxE2PlerET0Uhy8ASbJ36hO68PD3JM=)
  • Store them securely; never commit secrets to source control.

​
2. Authenticate via OAuth 2.0

  • Send a POST request to https://integrations.clopos.com/open-api/auth with your credentials.
  • On success, you receive: 
    {
  "success": true,
  "token": "oauth_...",
  "token_type": "Bearer",
  "expires_in": 3600
}
  • Tokens expire after 1 hour. Refresh them before they expire to avoid request failures.

​
3. Call your first endpoint

  • Use the access token in the x-token header along with x-brand and x-venue.
  • Example cURL request to list products: 
    curl -X GET "https://integrations.clopos.com/open-api/menu/products" \
  -H "x-token: oauth_example_token" \
  -H "x-brand: openapitest" \
  -H "x-venue: 1"
  • You can filter by product type, category, tags, and many more fields.

​
4. Explore the API surface

Need help? Contact our team at [email protected].