Aller au contenu

Endpoints API

Les 15 appels de l'API version 1, regroupés par étape. Chaque page détaille les en-têtes, les paramètres, le corps, des exemples dans 4 langages et une réponse réelle de la sandbox.

	Valeur
Adresse de base	`https://api.coveraf.com`
Environnement	Déduit de la clé : `cvr_test_` (sandbox) ou `cvr_live_` (production). Environnements
Format	JSON en UTF-8, sauf les documents (PDF).
Authentification	Clé API sur tous les appels, signature HMAC sur toutes les écritures. Authentification et signature
Version	`v1`, dans le chemin. Les évolutions compatibles (nouveaux champs) se font sans changer de version. Nouveautés

Vérification

Tester votre clé et votre signature, sans rien créer.

GETVérifier sa clé/v1/pingPOSTVérifier sa signature/v1/ping

Catalogue

Les offres ouvertes à votre compte et leurs Conditions Générales.

GETLister les offres/v1/produitsGETConsulter une offre/v1/produits/{code}GETConditions Générales/v1/produits/{code}/conditions-generales

Devis

Le prix, calculé par COVERAF et garanti 15 jours.

POSTCréer un devis/v1/devisGETConsulter un devis/v1/devis/{id}

Souscription

La demande du client, avant paiement. Aucun contrat n'existe encore.

POSTCréer une souscription/v1/souscriptionsGETConsulter une souscription/v1/souscriptions/{id}

Paiement

Mode A : vous déclarez votre encaissement. Mode B : COVERAF encaisse en Mobile Money.

POSTConfirmer un paiement (mode A)/v1/souscriptions/{id}/confirmer-paiementPOSTLancer un paiement (mode B)/v1/souscriptions/{id}/paiement

Contrats

Les contrats émis et leurs documents PDF.

GETLister les contrats/v1/contratsGETConsulter un contrat/v1/contrats/{numero}GETTélécharger un document/v1/contrats/{numero}/documents/{type}

Notifications

Vérifier que votre serveur reçoit bien les notifications.

POSTTester les notifications/v1/webhooks/test

Pour Postman, Insomnia ou un générateur de client

Toute l'API est décrite dans un fichier OpenAPI 3.1 : openapi.json. Importez-le pour obtenir tous les appels prêts à tester.