> ## Documentation Index
> Fetch the complete documentation index at: https://dom-6a1f70d6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Cette section vous aidera à démarrer avec l’API DOM Delivery Management en seulement quelques minutes.

## Que faire :

* Inscrivez-vous ou connectez-vous
* Allez dans la section **« Clés API »**.
* Cliquez sur **« Générer une clé API »**.
* Copiez la clé privée qui s’affiche

> [!WARNING]
>
> \*\*Important \*\*: chaque clé est unique pour l’utilisateur et \*\*ne doit pas être partagée ni exposée \*\*publiquement.

## 1. Créer un compte

Pour interagir avec l’API, inscrivez-vous d’abord en tant qu’utilisateur :

![image.png](https://mintcdn.com/dom-6a1f70d6/d9EfjmoUqUhLqAp-/images/image.png?fit=max\&auto=format\&n=d9EfjmoUqUhLqAp-\&q=85\&s=0a55cc146e3983213e9bfb58b03c5620)

## 2. S’authentifier et obtenir un jeton

Connectez-vous pour recevoir votre jeton d’accès :

```filename theme={null}
{
  "email": "your@email.com",
  "mot_de_passe": "yourpassword"
}
```

```json filename theme={null}
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1YzQxZTJkYS0zNzBhLTQ5YjgtYjNlZi0xZDgwOTI0NzA4NmYiLCJleHAiOjE3MDA4NDA0MDB9.6L-0htJpZKT9sNlzZAYI0Z1EK0e9U1nm3utBNVft5m8",
  "token_type": "bearer"
}
```

## 3. Installez une bibliothèque cliente HTTP dans le répertoire de votre projet.

Si vous utilisez JavaScript (React, Node.js, etc.) :

```bash filename theme={null}
npm install axios
```

Si vous utilisez Python :

```bash filename theme={null}
pip install requests
```

## 4. Stockez la clé API

Dans une variable d’environnement ou un fichier de configuration sécurisé dans le projet.

### Exemple:

Si vous utilisez JavaScript (React, Node.js, etc.) :

> [!WARNING]
>
> **Ne jamais coder la clé en dur dans des dépôts de code publics.**

```.env theme={null}
API_KEY=eyJhbGciOiJIUzI1NiIsInR...
```

Si vous utilisez Python :

```bash config.js theme={null}
API_KEY=eyJhbGciOiJIUzI1NiIsInR...
```

```settings.py theme={null}
API_KEY=eyJhbGciOiJIUzI1NiIsInR...
```

## 5. Utilisez la clé dans les requêtes HTTP

Exemple 1 – Projet JavaScript (React, Node.js…)

```javascript services/api.js or App.js theme={null}
import axios from "axios";

const API_BASE_URL = "https://your-api.com"; // Your FastAPI base URL
const API_KEY = process.env.API_KEY || "eyJhbGciOiJIUzI1NiIs..."; // API key

export const getOrders = async () => {
  try {
    const res = await axios.get(`${API_BASE_URL}/commandes/`, {
      headers: {
        Authorization: `Bearer ${API_KEY}`
      }
    });
    return res.data;
  } catch (error) {
    console.error("API error:", error.response.data);
  }
};

```

Exemple 2 – Projet Python (Flask, FastAPI, etc.)

```javascript main.py theme={null}
import requests

API_KEY = "eyJhbGciOiJIUzI1NiIs..."  # Your API key
BASE_URL = "https://your-api.com"

headers = {
    "Authorization": f"Bearer {API_KEY}"
}

response = requests.get(f"{BASE_URL}/livreurs/", headers=headers)

print(response.status_code)
print(response.json())

```

## 6. Tester l’API

> [!TIP]
>
> **DOM API DOCUMENTATION**

> Vous pouvez tester les points de terminaison directement dans le navigateur.

#### Étapes:

1. Allez dans votre **DOCUMENTATION API DOM**.
2. Accédez à la section **api-reference**.
3. Dans la barre latérale, choisissez une route (par exemple, **GET /commandes/**).
4. Cliquez sur la route pour afficher les détails.
5. Cliquez sur le bouton **« Try It »**.
6. Saisissez tous les paramètres ou en-têtes requis (par exemple, **Authorization**).
7. Cliquez sur **Envoyer la requête**.

   ![Api Reference Pn](https://mintcdn.com/dom-6a1f70d6/d9EfjmoUqUhLqAp-/images/api_reference.png?fit=max\&auto=format\&n=d9EfjmoUqUhLqAp-\&q=85\&s=a92e7a771f586ec12123b25784ba5356)

La réponse apparaîtra en dessous avec le code de statut et les données.

> [!WARNING]
>
> Utilisez votre clé API dans l’en-tête comme suit :

```json theme={null}
Authorization: Bearer <your_api_key>
```

> [!TIP]
>
> **POSTMAN**

> Postman est un outil populaire pour tester les API REST.

#### Étapes:

1. Ouvrez [https://postman.com](https://postman.com) ou lancez l’application.
2. Cliquez sur **Nouveau → Requête HTTP**.
3. Saisissez l’URL de votre API, par exemple :

```
GET https://your-api.com/commandes/
```

1. Allez dans l’onglet **Autorisation** :
   * **Type** : Bearer Token
   * **Token** : votre\_clé\_api
2. Cliquez sur **Envoyer**.

Vous verrez la réponse dans le panneau inférieur.

> [!TIP]
>
> **SWAGGER UI (FastAPI)**

> FastAPI inclut par défaut une interface interactive **Swagger UI**.

#### Étapes:

1. Si vous exécutez localement, allez à :

   ```bash theme={null}
   http://localhost:8000/docs 
   ```

   Si vous êtes déployé sur Render :

   ```arduino theme={null}
   https://your-api.onrender.com/docs
   ```
2. Tous vos points de terminaison sont listés. Cliquez sur l’un d’eux pour l’ouvrir.
3. Cliquez sur **« Authorize »**, puis saisissez :

   ```php-template theme={null}
   Bearer <your_api_key>
   ```
4. Cliquez sur **« Try it out »**.
5. Remplissez les paramètres (le cas échéant) et cliquez sur **Exécuter**.

Vous verrez la requête complète et la réponse en dessous.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.