> ## Documentation Index
> Fetch the complete documentation index at: https://developer.clopos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Clopos Open API Documentation

> Secure and unified access to the Clopos ecosystem for POS, ordering, payments, and restaurant management services

# 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.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get up and running with the Clopos API in minutes
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Learn how to authenticate and secure your API requests
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/v2/authentication/auth">
    Explore all available endpoints and their usage
  </Card>

  <Card title="Support" icon="envelope" href="mailto:dev@clopos.com">
    Get help from our development team
  </Card>
</CardGroup>

## What you can do with the Clopos API

<AccordionGroup>
  <Accordion title="🔑 Authenticate securely">
    Use OAuth 2.0 tokens scoped to specific brands and venues for secure access to your data.
  </Accordion>

  <Accordion title="🛒 Manage resources">
    Access and manage products, menus, orders, receipts, payments, and customers with comprehensive CRUD operations.
  </Accordion>

  <Accordion title="📊 Query with consistency">
    Built-in pagination, filtering, and sorting capabilities across all endpoints for efficient data retrieval.
  </Accordion>

  <Accordion title="⚙️ Automate workflows">
    Streamline order synchronization, payment reconciliation, and reporting processes.
  </Accordion>

  <Accordion title="🚀 Extend Clopos">
    Build custom dashboards, delivery integrations, and mobile applications on top of our platform.
  </Accordion>
</AccordionGroup>

## Base URL

All API requests should be made to:

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

## API Version

Current API version: **v2**. Version 1 is deprecated and no longer appears in the navigation; existing integrations can still reach v1 pages by direct link while you migrate.

## Getting Started

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

### 1. Request access credentials

* Request API access by filling out [this form](https://forms.gle/Y9P1Wnv4QFAruxny8). Clopos will issue your `client_id`, `client_secret`, `brand`, and `integrator_id`.
* 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:
  ```json theme={null}
  {
    "client_id": "your_client_id",
    "client_secret": "your_client_secret",
    "brand": "your_brand",
    "integrator_id": "your_integrator_id"
  }
  ```
* On success, you receive a JWT:
  ```json theme={null}
  {
    "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:
  ```bash theme={null}
  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](/quickstart) for a scripted example.
* See the [Authentication reference](/authentication) for header requirements and helpers.
* Dive into the [API reference](/api-reference/v2/overview) or jump directly to key endpoints like [List Products](/api-reference/v2/products/get-all-products).

Need help? Contact our team at [dev@clopos.com](mailto:dev@clopos.com).