Documentation

Documentation
technique

Tout ce dont vous avez besoin pour intégrer Atlas Livraison à votre système. API RESTful, webhooks et guides.

Démarrage rapide

Accédez à Paramètres API et générez une clé

Envoyez votre première requête :

curl -X POST https://api.your-domain.ma/api/external/colis \
  -H "Content-Type: application/json" \
  -H "X-API-Key: votre_cle_api" \
  -d '{
    "recipientName": "Ahmed",
    "recipientPhone": "0612345678",
    "recipientCity": "Casablanca",
    "recipientAddress": "123 Rue X",
    "amount": 200
  }'

🔑

Authentification

Clés API

Générez et gérez vos clés API depuis le dashboard.

Header d'authentification

Envoyez votre clé via le header X-API-Key.

Sécurité

Les clés sont hashées SHA-256. Ne les partagez jamais.

📦

Colis

POST /api/external/colis

Créer un nouveau colis avec nom, téléphone, ville, adresse et montant.

GET /api/external/colis/:code

Obtenir l'état actuel d'un colis par son code de suivi.

GET /api/external/track/:code

Endpoint public pour le suivi client (pas de clé requise).

🔔

Webhooks

POST /api/external/webhook/order

Recevez des commandes depuis votre CMS automatiquement.

Événements

colis:created, colis:state_changed, bl:created, facture:created.

Retries

Les webhooks sont retentés 3 fois en cas d'échec.

📋

Formats de données

Import CSV

Colonnes : nom, téléphone, ville, adresse, montant, description.

États du colis

25+ états possibles : Nouveau, Collecté, En cours, Livré, Retourné...

Types de BL

BRAC, BRAA, BRAP, BRAR, BSOL, BSOA, BLLA, BREL, BREA, BREVA, BREC, BRLA.

Documentationtechnique