IvoirRapid API

Console de test et débogage

Base URL : https://client.ivoirrapid.ci

Coursiers

GET /api/all-coursiers

GET /api/coursier/show/

Ramassage (Plis)

GET /api/coursiers/plis-all-ram/

GET /api/coursiers/plis-ram-sans-statut/

Dépôt (Plis)

GET /api/coursiers/plis-all-depot/

GET /api/coursiers/plis-depot-sans-statut/

Destinataires & Zones

GET /api/destinataires

GET /api/coursiers/by-zone/

GET /api/coursiers/destinataires/zones

Courses Occasionnelles

GET /api/coursiers/cours-occasionnelle/

Résultat de la requête

Cliquez sur un bouton "Tester" pour exécuter une requête API...

Depot Validation API

API webhook pour valider et gérer les dépôts depuis votre application externe

🔐 Authentification

Tous les endpoints requièrent un token d'authentification via le header Authorization

Format du header :

Authorization: Bearer <your_token_here>

Demander mon token

POST /api/v1/depot/validate

Valide un dépôt et enregistre les photos

🔗 URL complète :

https://client.ivoirrapid.ci/api/v1/depot/validate

📤 Requête

{
  "code": "26-01-000165",
  "photos": [
    "https://exemple.com/photo1.jpg",
    "https://exemple.com/photo2.jpg"
  ],
  "external_ref": "ext-unique-001",
  "validated_at": "2026-01-15T14:30:00Z"
}

📥 Réponse (201)

{
  "status": "success",
  "message": "Dépôt validé...",
  "data": {
    "pli_id": 42234,
    "code": "26-01-000165",
    "statut": "déposé",
    "date": "2026-01-15T14:30:00Z",
    "photos_count": 2
  }
}

Paramètres :

• code (required) : Code unique du pli
• photos (optional) : Array d'URLs des photos
• external_ref (required) : ID unique pour l'idempotence
• validated_at (optional) : Date ISO 8601

POST /api/v1/depot/cancel

Annule un dépôt validé précédemment

🔗 URL complète :

https://client.ivoirrapid.ci/api/v1/depot/cancel

📤 Requête

{
  "code": "26-01-000165",
  "reason": "Client pas disponible",
  "external_ref": "ext-cancel-001",
  "cancelled_at": "2026-01-15T14:35:00Z"
}

📥 Réponse (201)

{
  "status": "success",
  "message": "Dépôt annulé avec succès",
  "data": {
    "pli_id": 42234,
    "code": "26-01-000165",
    "statut": "annulé",
    "reason": "Client pas disponible",
    "date": "2026-01-15T14:35:00Z"
  }
}

Paramètres :

• code (required) : Code du pli à annuler
• reason (required) : Raison de l'annulation
• external_ref (required) : ID unique pour l'idempotence
• cancelled_at (optional) : Date ISO 8601

POST /api/v1/depot/reset

Réinitialise tous les statuts API d'un pli (test uniquement)

🔗 URL complète :

https://client.ivoirrapid.ci/api/v1/depot/reset

📤 Requête

{
  "code": "26-01-000165"
}

📥 Réponse (200)

{
  "status": "success",
  "message": "Réinitialisation effectuée",
  "data": {
    "pli_id": 42234,
    "code": "26-01-000165",
    "histories_deleted": 2
  }
}

❌ Codes HTTP & Erreurs

401

Non authentifié

Token invalide ou manquant

404

Pli introuvable

Le code saisi n'existe pas en base

409

Conflit / Déjà traité

Dépôt déjà validé, ou statut invalide pour annulation

422

Données invalides

Payload invalide ou pli sans attribution dépôt

500

Erreur serveur

Erreur interne du serveur

♻️ Idempotence

L'external_ref doit être unique et immuable. Si vous renvoyez la même requête, vous recevrez le même résultat sans doublon.

Utilisation recommandée : UUID v4 ou SHA-256 du timestamp + identifiant métier