Aller au contenu principal

Authentification

Toutes les requêtes API nécessitent une authentification via une clé API. Il existe deux façons de passer votre clé.

Méthodes d'authentification​

Authentification par header (recommandée)​

Passez votre clé API dans le header HTTP X-Api-Key :

curl -H "X-Api-Key: gm_YOUR_API_KEY" \
  "https://api.geocodeme.net/v1/geocode?q=Paris"

Authentification par paramètre de requête​

Passez votre clé API dans le paramètre de requête api_key :

curl "https://api.geocodeme.net/v1/geocode?q=Paris&api_key=gm_YOUR_API_KEY"
Note de sécurité

Les clés API passées en paramètre de requête peuvent fuiter via les journaux d'accès des serveurs, l'historique du navigateur, les headers Referer et les journaux des proxys. Préférez toujours l'authentification par header pour les applications en production. N'utilisez l'authentification par paramètre de requête que pour des tests rapides ou dans des environnements où les headers ne peuvent pas être définis.

info

Le header X-Api-Key est prioritaire si les deux méthodes sont fournies dans la même requête.

Format de clé API​

Les clés API suivent ce format :

  • Préfixe : gm_
  • Longueur totale : 35 caractères (gm_ + 32 caractères compatibles URL : lettres, chiffres, - et _)
  • Exemple : gm_EXAMPLE00KEY00ONLY00aaabbbcccddd
attention

Les clés API ne sont affichées qu'une seule fois, à leur création. Stockez votre clé dans une variable d'environnement (par ex. GEOCODEME_API_KEY) et ne la committez jamais dans votre gestionnaire de versions.

Obtenir une clé API​

  1. Connectez-vous à votre compte sur geocodeme.net
  2. Rendez-vous dans Tableau de bord > Clés API
  3. Cliquez sur Créer une clé
  4. Copiez la clé immédiatement : elle ne sera plus affichée par la suite

Rotation des clés​

Pour effectuer la rotation d'une clé API :

  1. Allez dans Tableau de bord > Clés API
  2. Cliquez sur Révoquer sur la clé à remplacer
  3. Cliquez sur Créer une clé pour en générer une nouvelle
  4. Mettez à jour votre application avec la nouvelle clé

L'ancienne clé devient invalide immédiatement après sa révocation. Prévoyez une brève interruption de service pendant la rotation, ou créez la nouvelle clé avant de révoquer l'ancienne.