Aller au contenu principal

Authentification

Toutes les requêtes vers l'API geocodeme.net nécessitent une authentification via une clé API envoyée dans le header HTTP X-Api-Key.

Obtenir votre clé API​

  1. Rendez-vous sur geocodeme.net et créez un compte ou connectez-vous
  2. Allez dans Tableau de bord → Clés API
  3. Cliquez sur Créer une clé et donnez-lui un nom descriptif
  4. Copiez la clé générée : votre clé n'est affichée qu'une seule fois, à sa création. Stockez-la dans un fichier .env ou un gestionnaire de secrets. Ajoutez .env à votre .gitignore pour éviter de committer accidentellement des secrets dans votre gestion de versions.
info

Vous n'avez pas encore de compte ? Créez-en un sur geocodeme.net

Format de la clé API​

Les clés API utilisent le préfixe gm_ suivi de 32 caractères aléatoires compatibles URL, par exemple :

gm_EXAMPLE00KEY00ONLY00aaabbbcccd

(L'exemple ci-dessus n'est pas une vraie clé ; remplacez-le par la vôtre.)

Cela donne une longueur totale de 35 caractères (préfixe gm_ de 3 caractères + 32 caractères aléatoires).

Utiliser votre clé API​

Incluez votre clé API dans le header X-Api-Key de chaque requête :

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

Voir le Démarrage rapide pour des exemples complets et fonctionnels en cURL, Python, JavaScript et PHP.

Limites de débit​

Chaque plan dispose de limites de requêtes différentes :

PlanRequêtes/secondeQuota de crédits
Free13 000 / jour
Startup10150 000 / mois
Growth15500 000 / mois
Pro251 500 000 / mois

Voir les tarifs en vigueur pour le détail des plans.

Lorsque vous dépassez votre limite de débit par seconde, l'API retourne un statut 429 avec le code d'erreur RATE_LIMIT_EXCEEDED ; lorsque votre quota mensuel est épuisé, elle retourne 429 avec QUOTA_EXCEEDED. Voir Limitation de débit pour le détail des headers et des stratégies de retry.

Bonnes pratiques de sécurité​

  • N'exposez jamais votre clé dans du code côté client : les clés API présentes dans des bundles JavaScript, des applications mobiles ou des dépôts publics peuvent être extraites par n'importe qui. Faites toujours transiter les requêtes par votre backend.
  • Utilisez la variable d'environnement GEOCODEME_API_KEY : c'est le nom recommandé, utilisé dans tous les exemples de code. Stockez votre clé dans cette variable et lisez-la à l'exécution. Ne codez jamais de clés en dur dans les fichiers sources.
  • Ajoutez .env à votre .gitignore : si vous stockez votre clé dans un fichier .env, assurez-vous qu'il est exclu de la gestion de versions. Pour les projets Next.js, utilisez plutôt .env.local (il est ignoré par git par défaut).
  • Effectuez une rotation immédiate en cas de compromission : si vous soupçonnez une fuite de clé, révoquez-la dans le tableau de bord et créez-en une nouvelle.