Aller au contenu
Support

Vérifier sa clé

Vérifie votre clé et indique l'environnement (test ou live).

GEThttps://api.coveraf.com/v1/ping
Réponse JSON 200Sandbox et production
À faire en premier

Appelez-le au démarrage de votre serveur : il confirme que la clé est bonne et que vous êtes dans l'environnement attendu (environnement).

En-têtes

En-têteObligatoireValeur
AuthorizationouiBearer suivi de votre clé API (cvr_test_... ou cvr_live_...).

Exemple de requête

curl https://api.coveraf.com/v1/ping \
  -H "Authorization: Bearer $COVERAF_CLE_API"

Réponse

Succès (200), réponse réelle de la sandbox
{
  "ok": true,
  "environnement": "test",
  "partenaire": "Votre société",
  "signature_verifiee": false,
  "date_serveur": "2026-11-04T17:35:32.433Z"
}

Erreurs possibles

CodeHTTPSignification
authentification_manquante401En-tête Authorization manquant. Envoyez « Authorization: Bearer <votre clé API> ».
cle_invalide401Clé API invalide ou révoquée.
compte_suspendu403Votre compte partenaire est suspendu. Contactez COVERAF.
production_non_autorisee403Votre compte n'est pas encore autorisé en production. Terminez la certification dans la sandbox.
ip_non_autorisee403Cette adresse IP n'est pas dans la liste des adresses autorisées pour votre compte.

S'y ajoutent les erreurs communes à tous les appels (clé, signature, limite de débit, service) : voir Codes d'erreur.