Bienvenue sur l’API ColisMove

ColisMove est une plateforme de transport collaboratif de colis entre particuliers (à la manière de BlaBlaCar, mais pour les colis). Des voyageurs disposant d’espace bagages disponible peuvent transporter les colis d’expéditeurs sur leur trajet.

Concepts clés

Annonces

Les transporteurs vérifiés créent des annonces de transport en précisant leur trajet, leurs dates et leur capacité disponible.

Réservations

Les expéditeurs réservent une place sur une annonce pour expédier leur colis. Le cycle de vie complet est piloté par une machine à états.

Paiements

Paiements sécurisés via Stripe Connect avec entiercement (escrow) plateforme. Le transporteur reçoit ses fonds uniquement après confirmation de la livraison.

Agences

Les agences professionnelles de transport peuvent s’enregistrer, gérer leurs branches, leurs employés et traiter des envois en masse.

Comment ça marche

URL de base

Tous les endpoints de l’API sont préfixés par :

https://api.colismove.com/v1/api

En développement local :

http://localhost:3091/v1/api

Démarrage rapide

Inscription

Créez un compte utilisateur via POST /v1/api/auth/register

Authentification

Connectez-vous pour obtenir vos tokens JWT via POST /v1/api/auth/login

Vérification KYC

Vérifiez votre identité via POST /v1/api/kyc/init pour débloquer les fonctionnalités transporteur

Utilisez l'API

Parcourez les annonces, créez des réservations ou publiez vos propres annonces

Audiences

L’API est segmentée en trois audiences distinctes selon le client appelant :

Particuliers

Mobile + Web particuliers — expéditeurs / transporteurs

Web Agence

Portail web pour agences professionnelles

Web SuperAdmin

Console d’administration plateforme