Référence API
Les 90 opérations de l'API Pool TPV, groupées par ressource, avec paramètres, schémas et exemples.
L'API Pool TPV est une API REST : URL orientées ressources, corps JSON, codes HTTP standards. Tous les chemins sont relatifs à la base de l'environnement.
Base URL (préproduction)
https://apigw-pp.pooltpv.app/subscription/api/v1Authentification
Chaque appel, sauf l'obtention du jeton, porte l'en-tête :
Authorization: Bearer <access_token>Le jeton s'obtient avec POST /provider/token (e-mail + mot de passe) et se renouvelle avec
POST /provider/token/refresh. Les rôles acceptés par chaque opération sont listés dans son bloc
« Authorization ». Voir Authentification.
Conventions
| Corps | JSON, camelCase, Content-Type: application/json |
| Dates | yyyy-MM-dd HH:mm:ss en entrée contrat, ISO 8601 ailleurs (détail) |
| Pagination | tableau en corps + en-têtes X-Page, X-Size, X-Total, X-Total-Pages |
| Filtres | filter[champ]=valeur (liste) |
| Erreurs | RFC 7807 : status, title, detail, exception (codes) |
Ressources
| Groupe | Ce qu'il couvre |
|---|---|
| Authentification | Jeton et rafraîchissement |
| Partenariats | Liens courtier – compagnie (companyBrokerId) |
| Souscripteurs, Assurés, Apporteurs | Les parties du contrat |
| Durées | Codes de durée de couverture |
| Référentiels véhicule | Marques, modèles, types, catégories, énergies, usages, genres, villes |
| Véhicules | Création, recherche, mise à jour |
| Contrats et propositions | Création, consultation, modification, tarification, décompositions |
| Paiements | Lien de paiement, statut, renvoi, annulation |
| Avenants et Motifs | Types, cotation, suivi, motifs |
| Documents | Documents d'un contrat ou d'un avenant |
| États (6 groupes) | Catalogue, sources et champs, aperçu et génération, modèles, exécutions, planifications |
Le schéma OpenAPI complet de cette référence est le fichier openapi.yml de ce site.