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

> Bienvenue dans la documentation de l'API Chariow

Chariow est une plateforme de commerce numérique qui vous permet de vendre des produits numériques, gérer des clients, traiter des paiements et gérer des clés de licence via une API simple.

## Fonctionnalités clés

<CardGroup cols={2}>
  <Card title="Produits" icon="box" href="/fr/guides/products">
    Créez et gérez des produits numériques avec des prix flexibles
  </Card>

  <Card title="Paiement" icon="shopping-cart" href="/fr/guides/checkout">
    Traitez les paiements de manière sécurisée via l'API
  </Card>

  <Card title="Clients" icon="users" href="/fr/guides/customers">
    Gérez les profils et l'historique des clients
  </Card>

  <Card title="Licences" icon="key" href="/fr/guides/licenses">
    Émettez et gérez des clés de licence logicielle
  </Card>
</CardGroup>

## Démarrage rapide

<Steps>
  <Step title="Créer une clé API">
    Connectez-vous à [app.chariow.com](https://app.chariow.com), allez dans **Paramètres** > **Clés API** et créez une nouvelle clé.
  </Step>

  <Step title="Faire votre première requête">
    Utilisez votre clé API pour récupérer les informations de votre boutique :

    ```bash theme={null}
    curl -X GET "https://api.chariow.com/v1/store" \
      -H "Authorization: Bearer VOTRE_CLE_API"
    ```
  </Step>

  <Step title="Explorer l'API">
    Parcourez la [référence API](/api-reference/introduction) pour découvrir tous les endpoints disponibles.
  </Step>
</Steps>

## URL de base

Toutes les requêtes API doivent être effectuées vers :

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

## Format des réponses

Toutes les réponses API suivent une structure JSON cohérente :

```json theme={null}
{
  "message": "success",
  "data": {
    // Données de la réponse
  },
  "errors": []
}
```

### Réponse réussie

```json theme={null}
{
  "message": "success",
  "data": {
    "id": "prd_abc123",
    "name": "Cours Premium",
    "price": {
      "value": 49,
      "formatted": "49,00 €",
      "short": "49",
      "currency": "EUR"
    }
  },
  "errors": []
}
```

### Réponse d'erreur

```json theme={null}
{
  "message": "La validation a échoué",
  "data": [],
  "errors": {
    "email": ["Le champ email est requis."],
    "product_id": ["Le produit sélectionné est invalide."]
  }
}
```

### Pagination

Les endpoints de liste utilisent une pagination par curseur :

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

Utilisez le paramètre `cursor` pour naviguer entre les pages :

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

## Limites de débit

L'API implémente des limites de débit pour garantir une utilisation équitable :

| Type d'endpoint         | Limite              |
| ----------------------- | ------------------- |
| Toutes les requêtes API | 100 requêtes/minute |

Les limites de débit sont appliquées par clé API. Chaque réponse inclut des en-têtes de limite de débit :

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

Lorsque vous dépassez la limite de débit, vous recevrez une réponse `429 Too Many Requests` :

```json theme={null}
{
  "message": "Trop de requêtes. Veuillez réessayer plus tard.",
  "data": [],
  "errors": []
}
```

<Info>
  Besoin de limites plus élevées ? Contactez-nous à [support@chariow.com](mailto:support@chariow.com) pour discuter des options entreprise.
</Info>

## Authentification

L'API utilise l'authentification Bearer token. Incluez votre clé API dans l'en-tête `Authorization` :

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

<Card title="En savoir plus sur l'authentification" icon="lock" href="/fr/introduction/authentication">
  Apprenez à sécuriser vos requêtes API
</Card>

## Besoin d'aide ?

<CardGroup cols={3}>
  <Card title="Référence API" icon="code" href="/api-reference/introduction">
    Documentation complète de l'API
  </Card>

  <Card title="Support" icon="life-ring" href="https://help.chariow.com">
    Contactez notre équipe
  </Card>

  <Card title="Communauté" icon="users" href="https://hub.chariow.com">
    Rejoignez la communauté
  </Card>
</CardGroup>
