Aller au contenu
canidata.fr

Authentification

Trois méthodes pour transmettre votre clé API canidata, et la gestion des clés partenaires.

Guide d'intégration

À valider avant production

Chaque guide relie le contrat API aux contraintes d'usage : clé, pagination, erreurs, fraîcheur et règles de réutilisation.

Démarrage API v1 JSON
Chemin d'intégration
monthly snapshot
Chemin d'intégration Lire guide Appeler api/v1 Contrôler erreurs Publier réseau

Toutes les routes de données nécessitent une clé API, à l’exception de /api/v1 (découverte) et /api/v1/status (monitoring), volontairement publiques.

Transmettre la clé

Trois méthodes, par ordre de préférence :

# 1. En-tête Authorization (recommandé)
curl https://canidata.fr/api/v1/stats \
  -H "Authorization: Bearer VOTRE_CLE"

# 2. En-tête X-API-Key
curl https://canidata.fr/api/v1/stats \
  -H "X-API-Key: VOTRE_CLE"

# 3. Paramètre de requête (à éviter en production : la clé apparaît dans les logs)
curl "https://canidata.fr/api/v1/stats?key=VOTRE_CLE"

Erreur d’authentification

Sans clé, l’API renvoie 401 avec un message explicite :

{
  "error": {
    "status": 401,
    "code": "missing_api_key",
    "message": "Clé API requise.",
    "hint": "Accès sur demande : écrivez à [email protected] en précisant votre cas d'usage."
  }
}

Obtenir une clé

L’API n’est pas publique : aucune clé n’est exposée sur le site ni dans le code. Chaque clé est personnelle, délivrée sur demande, et révocable. Les clés partenaires offrent un quota dédié et un accès aux exports CSV en masse. Écrivez à [email protected] en précisant votre cas d’usage.

Les clés ne doivent jamais être exposées côté navigateur. Pour un usage front, passez par un proxy serveur.

Continuer l'intégration