Reference API

Données de Référence

Endpoints pour récupérer les données nécessaires à la tarification et à la souscription.

But

Ces endpoints te permettent de récupérer dynamiquement les listes de valeurs (catégories, branches, marques, types de pièces d'identité, etc.) configurées dans l'agrégateur. Ces données sont indispensables pour construire tes formulaires de souscription et soumettre des requêtes valides (ex: brCode, catCode, scatCode).

Il est recommandé de mettre en cache ces données côté partenaire (ex: Redis ou en mémoire) pendant quelques heures pour éviter de solliciter l'API à chaque affichage de formulaire, car ces listes changent rarement.

Endpoints disponibles

La section interactive ci-dessous te permet d'explorer et de tester tous les endpoints de référence. Tu auras notamment besoin de :

  • Branches, Catégories, Sous-catégories : Pour identifier le type de véhicule ou d'assurance.
  • Marques, Carrosseries : Pour les détails du véhicule.
  • Pays, Types de pièces : Pour l'identité du client.
  • Packs : Pour les formules commerciales disponibles.

Référence interactive

GET
/api/v1/reference/branches
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "http://localhost:3210/api/v1/reference/branches"
Empty
GET
/api/v1/reference/categories
AuthorizationBearer <token>

In: header

Query Parameters

brCode*string

Code de la branche (ex: 500=Automobile)

Response Body

curl -X GET "http://localhost:3210/api/v1/reference/categories?brCode=500"
Empty
GET
/api/v1/reference/sub-categories
AuthorizationBearer <token>

In: header

Query Parameters

catCode*string

Code de la catégorie

Response Body

curl -X GET "http://localhost:3210/api/v1/reference/sub-categories?catCode=510"
Empty
GET
/api/v1/reference/body-types
AuthorizationBearer <token>

In: header

Query Parameters

scatCode*string

Code sous-catégorie

Response Body

curl -X GET "http://localhost:3210/api/v1/reference/body-types?scatCode=000"
Empty
GET
/api/v1/reference/brands
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "http://localhost:3210/api/v1/reference/brands"
Empty
GET
/api/v1/reference/countries
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "http://localhost:3210/api/v1/reference/countries"
Empty
GET
/api/v1/reference/id-types
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "http://localhost:3210/api/v1/reference/id-types"
Empty
GET
/api/v1/reference/packs
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "http://localhost:3210/api/v1/reference/packs"
Empty

On this page