Aller au contenu
Support

Documentation de l'API COVERAF

Proposez nos assurances directement dans votre application : votre client obtient un prix, souscrit, paie en Mobile Money et reçoit ses documents, sans quitter votre parcours.

Vue d'ensemble

Une API REST unique pour 11 offres d'assurance, réparties en 6 produits :

Avec elle, vous pouvez :

  • présenter le catalogue : les offres ouvertes à votre compte, leurs garanties et les informations à demander à votre client ;
  • calculer un prix : un devis calculé par COVERAF à partir des tarifs officiels, garanti 15 jours ;
  • souscrire et encaisser : vous encaissez votre client vous-même puis nous le confirmez, ou COVERAF l'encaisse en Mobile Money (Orange, MTN, Moov, Wave, Djamo) ;
  • remettre les documents : contrat émis dès le paiement confirmé, Conditions Générales, Conditions Particulières et attestation en PDF ;
  • être prévenu : votre serveur reçoit une notification à chaque paiement et à chaque contrat émis.

Démarrage rapide

1. Environnements disponibles

EnvironnementAdresseClé
Sandbox (test)https://api.coveraf.comcvr_test_...
Productionhttps://api.coveraf.comcvr_live_...

Même adresse, même code : c'est la clé qui choisit l'environnement. Voir Environnements.

2. Authentification

Chaque appel porte votre clé API. Chaque écriture est en plus signée avec votre secret (HMAC-SHA256) :

En-têtes
Authorization: Bearer cvr_test_...
X-Coveraf-Timestamp: 1793790000
X-Coveraf-Signature: v1=5f2b...

Voir Authentification et signature, avec des clients prêts à l'emploi en Node.js, Python, PHP et bash.

3. Premier appel

curl
curl https://api.coveraf.com/v1/ping \
  -H "Authorization: Bearer $COVERAF_CLE_API"
Réponse 200
{
  "ok": true,
  "environnement": "test",
  "partenaire": "Votre société",
  "signature_verifiee": false,
  "date_serveur": "2026-11-04T17:35:32.433Z"
}

Suite du tutoriel, jusqu'au premier devis : Démarrage rapide.

Ressources utiles

Les principes à connaître

PrincipeEn pratique
Le prix vient toujours de nousVous n'envoyez jamais de montant : il est calculé par l'API, et tout montant envoyé est ignoré.
Pas de contrat sans paiementLe contrat et ses documents n'existent qu'une fois le paiement confirmé. Seules les Conditions Générales sont consultables avant.
Appels de serveur à serveurVotre clé et votre secret restent sur votre serveur, jamais dans une application mobile ou une page web.
Des documents officielsEn production, les documents sont ceux de l'assureur, vérifiables. En sandbox, des documents de test sans valeur.
Obtenir vos accès

Écrivez à contact@optimus-ci.com. COVERAF ouvre votre compte et vous transmet une clé de test et son secret de signature. La clé de production est remise après vos tests et la signature de la convention de partenariat (voir Passage en production).