API Pool TPV
Tout ce qu'il faut pour intégrer la souscription, le paiement, les avenants et les états du Pool TPV dans votre logiciel métier.
Bienvenue
L'API Pool TPV est l'interface d'intégration du Pool TPV (assurance automobile des transports
publics de voyageurs) destinée aux compagnies d'assurance, aux courtiers et aux éditeurs de
logiciels métier. Tous ses endpoints vivent sous le préfixe /provider et parlent JSON.
Elle couvre deux grands domaines :
- La souscription : partenariats, souscripteurs, assurés, apporteurs, véhicules, propositions, tarification, paiement en ligne, avenants et documents.
- Les états : 24 états prédéfinis (quittancement, récapitulatifs de production, encaissements, coassurance, impayés…) et un moteur d'états personnalisés avec aperçu, génération PDF/CSV/XLSX, modèles enregistrés et planifications.
POST https://apigw-pp.pooltpv.app/subscription/api/v1/provider/token
Content-Type: application/jsonCommencer
Démarrage rapide
Du jeton à la première proposition payée, en 7 appels commentés.
Authentification
Jeton Bearer, rafraîchissement, rôles et périmètre des données.
Conventions
Format JSON, dates, pagination par en-têtes, filtres filter[...], enveloppe ActionResponse.
Erreurs
Format RFC 7807, codes métier et conduite à tenir.
Souscrire
Parcours de souscription
La séquence complète et les identifiants à collecter avant de créer une proposition.
Propositions et tarification
Créer, consulter, modifier une proposition DRAFT et lire la décomposition de prime.
Paiement
Générer le lien de paiement, suivre le statut, renvoyer ou annuler un lien.
Avenants
Types, motifs, cotation, paiement et suivi des actes de gestion.
Éditer des états
Les états en 3 étapes
Choisir un état du catalogue, le prévisualiser, le générer et télécharger le fichier.
États personnalisés
Construire sa propre spécification : source, colonnes, formules, filtres, période, regroupements.
Catalogue des états
Les 24 états prédéfinis, leur code, leur source et leur règle de calcul.
Référence API
Chaque endpoint /provider avec ses paramètres, ses schémas et des exemples.
En bref
| Base URL préproduction | https://apigw-pp.pooltpv.app/subscription/api/v1 |
| Authentification | Authorization: Bearer <access_token> (e-mail + mot de passe) |
| Format | JSON, champs en camelCase, montants en FCFA |
| Pagination | corps = tableau, métadonnées dans X-Page, X-Size, X-Total, X-Total-Pages |
| Erreurs | RFC 7807 (status, title, detail, exception) |
| Version de l'API | 1.3 |