Vue d'ensemble
API partenaire assurance: créer une demande de contrat, obtenir un lien de paiement, puis suivre l'émission.
Flow assurance-first
Cree une demande de contrat, obtiens un lien de paiement, puis laisse la plateforme emettre automatiquement apres paiement confirme.
Reference API interactive
Explore les schemas Swagger reels, teste les endpoints et recupere les exemples de requetes sans quitter la doc.
Webhooks securises
Recois les notifications insurance.contract.issued et
insurance.contract.issuance_failed avec signature HMAC.
Sandbox & recette
Prepare les tests d integration, la recette webhook et la validation avant mise en production.
Endpoints partenaires
3
Creation de contrat, lecture de statut et configuration webhook.
Webhooks sortants
2
insurance.contract.issued et insurance.contract.issuance_failed.
Principe
1 flow
Assurance-first: paiement avant emission effective.
Pourquoi cette API existe
L'objectif n'est pas d'exposer la complexite d'un provider paiement ou d'ASKIA. L'objectif est de donner au partenaire une API assurance simple:
- preparer une demande de contrat,
- creer une demande de contrat,
- rediriger vers un lien de paiement,
- recuperer le contrat emis ou l'erreur d'emission.
À qui s'adresse cette documentation
Cette documentation est destinée aux équipes d'intégration backend des partenaires distributeurs (banques, néobanques, marketplaces, courtiers, aggrégateurs tiers) qui souhaitent revendre des contrats d'assurance automobile émis par ASKIA via notre plateforme d'agrégation.
Cette documentation décrit uniquement les endpoints et webhooks exposés aux partenaires. Les endpoints d'administration ne sont pas couverts ici.
Ce que fait l'API Partenaire
En tant que partenaire vous pouvez :
- créer une demande de contrat et récupérer un lien de paiement,
- suivre le statut métier du contrat (en attente, actif, échec, remboursé),
- configurer votre webhook de réception d'événements,
- recevoir automatiquement le contrat émis (ou la cause d'échec) sur votre webhook.
Avant le premier test
- Recuperer une cle
sandboxet un compte partenaire de recette. - Configurer un endpoint webhook HTTPS ou un tunnel local.
- Tester le flow complet depuis Reference API puis valider les cas
issuedetissuance_failed.
Les pages de la section Reference API sont maintenant interactives:
schémas Swagger réels, exemples générés et bouton de test directement dans la doc.
Vous ne pouvez pas :
- créer un contrat directement (émission auto réservée à l'administration),
- modifier un contrat déjà émis,
- contourner le paiement via la passerelle de paiement.
Règle d'or : le flow payment-first
La création d'un contrat est pilotée par le paiement. Autrement dit, aucun contrat n'est émis tant qu'un paiement n'est pas confirmé.
Le partenaire manipule une reference metier stable. Elle sert a corriger les webhooks, relire un statut et suivre tout le cycle de vie du contrat.
Endpoints essentiels
/api/v1/partner/contracts/auto/classicCree une demande de contrat et retourne une reference ainsi qu un
paymentUrl.
/api/v1/partner/contracts/requests/{reference}Relit l etat metier de la demande: paiement en attente, emission en cours, contrat actif ou emission en echec.
/api/v1/partners/me/webhookConfigure l URL webhook du partenaire et le secret de signature sortante.
Demande de contrat
Le partenaire appelle
POST /api/v1/partner/contracts/auto/classicavec les données de souscription. L'agrégateur retourne unereferenceet unpaymentUrl.Paiement
L'utilisateur final est redirigé vers
payment_urlet règle sa prime.Webhook entrant paiement
La passerelle notifie l'agrégateur sur
POST /api/v1/webhooks/dexpayavec une signaturex-webhook-signature(HMAC SHA256).Émission ASKIA
L'agrégateur déclenche l'émission du contrat côté ASKIA.
Webhook sortant partenaire
L'agrégateur POST vers l'URL webhook du partenaire un événement
insurance.contract.issued(succès) ouinsurance.contract.issuance_failed(échec).Suivi de statut
Optionnel:
GET /api/v1/partner/contracts/requests/:referencepour la réconciliation.
Toute intégration qui tente d'appeler directement /contracts/auto/* avec un
rôle partner reçoit 403 Forbidden. Utilisez le flow payment-first.
Architecture en un coup d'œil
sequenceDiagram
participant P as Partenaire
participant U as Utilisateur
participant AGG as Agrégateur
participant DX as Paiement
participant AS as ASKIA
P->>AGG: POST /partner/contracts/auto/classic
AGG->>DX: Création session
DX-->>AGG: payment_url, reference
AGG-->>P: 201 { payment_url, reference }
P->>U: Redirection vers payment_url
U->>DX: Paiement
DX->>AGG: POST /webhooks/dexpay (HMAC)
AGG->>AS: Émission contrat
AS-->>AGG: Contrat émis (ou erreur)
AGG->>P: POST webhook partenaire (signé)
P->>AGG: GET /partner/contracts/requests/:reference (optionnel)Environnements
Les URL exactes sandbox/production sont communiquées pendant l'onboarding. Conservez une stricte séparation des clés et webhooks par environnement.
Parcours recommande
- Lire Authentification.
- Lire Flow assurance-first.
- Tester
POST /partner/contracts/auto/classicdans la Reference API. - Configurer le webhook partenaire.
- Valider les cas
issuedetissuance_faileden sandbox. - Passer la Go-live checklist.
Prochaines étapes
Comprendre le parcours complet de la demande au contrat actif.
Tester les endpoints et consulter les schemas OpenAPI reels.
Verifier la signature et traiter les emissions en temps reel.
Valider les prerequis de production avant ouverture partenaire.