Aperçu des Endpoints

Aperçu des Endpoints de l’API

L’API REST de myumbrella.ai est organisée autour de ressources. Tous les endpoints utilisent des corps de requête/réponse en JSON et des méthodes HTTP standard.

URL de Base : https://api.myumbrella.ai/v1

Plans de Garantie

Méthode	Endpoint	Description
GET	/plans	Lister tous les plans
POST	/plans	Créer un nouveau plan
GET	/plans/:id	Obtenir les détails d’un plan
PUT	/plans/:id	Mettre à jour un plan
DELETE	/plans/:id	Archiver un plan

Exemple : Créer un Plan

curl -X POST https://api.myumbrella.ai/v1/plans \
  -H "Authorization: Bearer mu_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "2-Year Protection",
    "coverage": ["mechanical", "accidental"],
    "duration_months": 24,
    "price_model": "percentage",
    "rate": 0.12
  }'

Réclamations

Méthode	Endpoint	Description
GET	/claims	Lister les réclamations (filtrable)
POST	/claims	Déposer une nouvelle réclamation
GET	/claims/:id	Obtenir les détails d’une réclamation
PATCH	/claims/:id	Mettre à jour le statut d’une réclamation
POST	/claims/:id/notes	Ajouter une note à une réclamation

Contrats

Méthode	Endpoint	Description
GET	/contracts	Lister les contrats actifs
GET	/contracts/:id	Obtenir les détails d’un contrat
POST	/contracts/:id/cancel	Annuler un contrat

Analyses

Méthode	Endpoint	Description
GET	/analytics/revenue	Résumé des revenus
GET	/analytics/claims	Métriques des réclamations
GET	/analytics/attach-rate	Taux d’adhésion dans le temps

Pagination

Tous les endpoints de liste prennent en charge la pagination basée sur un curseur :

GET /v1/plans?limit=25&starting_after=plan_xyz

La réponse inclut un booléen has_more et des métadonnées de pagination.