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

# API Introduction

> Welcome to the Chariow API Reference

The Chariow API is a RESTful API that allows you to programmatically interact with your store. You can use it to retrieve products, manage customers, process sales, validate licenses, and more.

## Base URL

All API requests should be made to:

```
https://api.chariow.com/v1
```

## Authentication

The API uses Bearer token authentication. Include your API key in the `Authorization` header:

```bash theme={null}
Authorization: Bearer sk_live_your_api_key
```

<Card title="Get your API key" icon="key" href="https://app.chariow.com/settings/api">
  Generate API keys in your store dashboard
</Card>

## Request Format

* All requests should include `Content-Type: application/json` header for POST/PUT requests
* Request bodies should be JSON encoded
* Query parameters should be URL encoded

## Response Format

All responses follow a consistent JSON structure:

```json theme={null}
{
  "message": "success",
  "data": {
    // Response data
  },
  "errors": []
}
```

### Pagination

List endpoints use cursor-based pagination:

```json theme={null}
{
  "data": {
    "data": [...],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  }
}
```

Use the `cursor` query parameter to navigate pages:

```
GET /v1/products?cursor=eyJpZCI6NTB9&per_page=20
```

## Available Endpoints

<CardGroup cols={2}>
  <Card title="Store" icon="store" href="/api-reference/store/get-store">
    Retrieve store information
  </Card>

  <Card title="Products" icon="box" href="/api-reference/products/list-products">
    List and retrieve products
  </Card>

  <Card title="Checkout" icon="shopping-cart" href="/api-reference/checkout/init-checkout">
    Initiate checkout sessions
  </Card>

  <Card title="Sales" icon="receipt" href="/api-reference/sales/list-sales">
    Manage sales and orders
  </Card>

  <Card title="Customers" icon="users" href="/api-reference/customers/list-customers">
    Customer management
  </Card>

  <Card title="Licenses" icon="key" href="/api-reference/licenses/list-licenses">
    License key management
  </Card>

  <Card title="Discounts" icon="tag" href="/api-reference/discounts/list-discounts">
    Discount code management
  </Card>

  <Card title="Pulses" icon="bell" href="/api-reference/pulses/list-pulses">
    Webhook notification pulses
  </Card>
</CardGroup>

## Rate Limits

| Endpoint Type    | Limit   |
| ---------------- | ------- |
| All API requests | 100/min |

Rate limits are applied per API key. See [Rate Limits](/en/resources/rate-limits) for more details.

## Need Help?

<CardGroup cols={3}>
  <Card title="Guides" icon="book" href="/en/introduction/overview">
    Step-by-step tutorials
  </Card>

  <Card title="Support" icon="life-ring" href="https://help.chariow.com">
    Get help from our team
  </Card>

  <Card title="Community" icon="discord" href="https://discord.gg/chariow">
    Join the community
  </Card>
</CardGroup>
