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

# Introduction

> Welcome to Chariow - The all-in-one platform for selling digital products

## What is Chariow?

Chariow is a powerful e-commerce platform designed specifically for creators and businesses selling digital products. Whether you're selling courses, software licenses, downloadable files, or digital services, Chariow provides everything you need to manage your store, process payments, and deliver products to your customers.

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

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

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Explore the complete API documentation
  </Card>

  <Card title="MCP Integration" icon="robot" href="/en/mcp/overview">
    Connect Chariow to AI assistants via Model Context Protocol
  </Card>
</CardGroup>

## Base URL

All API requests should be made to:

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

## Response Format

All API responses follow a consistent JSON structure:

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

### Successful Response

```json theme={null}
{
  "message": "success",
  "data": {
    "id": "prd_abc123",
    "name": "Premium Course",
    "price": {
      "value": 99,
      "formatted": "$99.00",
      "short": "99",
      "currency": "USD"
    }
  },
  "errors": []
}
```

### Error Response

```json theme={null}
{
  "message": "Validation failed",
  "data": [],
  "errors": {
    "email": ["The email field is required."],
    "product_id": ["The selected product is invalid."]
  }
}
```

### Pagination

List endpoints use cursor-based pagination:

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

Use the `cursor` query parameter to navigate pages:

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

## Rate Limits

The API implements rate limiting to ensure fair usage:

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

Rate limits are applied per API key. Each response includes rate limit headers:

```http theme={null}
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 98
X-RateLimit-Reset: 1642089600
```

When you exceed the rate limit, you'll receive a `429 Too Many Requests` response:

```json theme={null}
{
  "message": "Too many requests. Please try again later.",
  "data": [],
  "errors": []
}
```

<Info>
  Need higher rate limits? Contact us at [support@chariow.com](mailto:support@chariow.com) to discuss enterprise options.
</Info>

## Key Features

<AccordionGroup>
  <Accordion title="Digital Products" icon="box">
    Sell any type of digital product:

    * **Downloadable files** - PDFs, videos, music, software
    * **Online courses** - With chapters, lessons, and progress tracking
    * **Software licenses** - Automatic license key generation and activation
    * **Bundles** - Combine multiple products into one offering
    * **Services** - Book consultations or digital services
  </Accordion>

  <Accordion title="Flexible Pricing" icon="money-bill">
    Multiple pricing options to suit your business:

    * One-time payments
    * Pay-what-you-want pricing
    * Free products for lead generation
    * Discount codes and promotions
  </Accordion>

  <Accordion title="Customer Management" icon="users">
    Complete customer lifecycle management:

    * Customer profiles and purchase history
    * License key management
    * Automated email notifications
    * Customer portal access
  </Accordion>

  <Accordion title="Developer API" icon="terminal">
    Build custom integrations with our comprehensive API:

    * RESTful API with JSON responses
    * Pulse notifications for real-time events
    * MCP integration for AI assistants
    * SDK support (coming soon)
  </Accordion>
</AccordionGroup>

## Use Cases

<Steps>
  <Step title="Course Creators">
    Build and sell online courses with video hosting, progress tracking, and completion certificates.
  </Step>

  <Step title="Software Developers">
    Distribute software with automatic license key generation, activation limits, and expiration management.
  </Step>

  <Step title="Digital Agencies">
    Sell templates, design assets, and digital resources with instant delivery.
  </Step>

  <Step title="Content Creators">
    Monetise ebooks, music, photography, and other creative works.
  </Step>
</Steps>

## Getting Help

<CardGroup cols={3}>
  <Card title="Help Center" icon="life-ring" href="https://help.chariow.com">
    Browse our knowledge base
  </Card>

  <Card title="Community" icon="users" href="https://hub.chariow.com">
    Join our community
  </Card>

  <Card title="Support" icon="envelope" href="mailto:support@chariow.com">
    Contact our support team
  </Card>
</CardGroup>
