Aller au contenu

Authentification

Clés secrètes sandbox, accès, durée de vie et bonnes pratiques.

En-tête Authorization

Envoyez la clé à chaque requête dans l’en-tête Authorization, avec le schéma Bearer.

Authorization: Bearer $ATLAS_API_KEY

Une clé sandbox commence par atlas_sk_sandbox_, suivi de 43 lettres et chiffres. La console n’en montre ensuite que le préfixe et les quatre derniers caractères.

Protéger une clé

  • Gardez la clé côté serveur, dans une variable d’environnement ou un gestionnaire de secrets.
  • Ne la placez jamais dans un navigateur, une application mobile, un dépôt de code, une URL ou un journal.
  • L’API n’envoie pas d’en-têtes CORS : un navigateur ne peut pas l’appeler directement.
  • Révoquez dans la console toute clé exposée. La révocation est immédiate et définitive.

Accès

Chaque clé reçoit ses accès à sa création, et ils ne changent plus. Une route demandée sans l’accès requis répond 403 insufficient_scope.

Accès
AccèsRoutesStatut
search:read

Recherche de localités.

Disponible
places:read

Lieux : liste, recherche et détail.

Disponible
maps:read

Tuiles et styles de carte. Aucune route ne l’accepte encore.

Pas encore disponible

Durée de vie

  • Chaque clé expire après 30, 90 ou 365 jours, 90 par défaut.
  • Un projet garde au plus 5 clés actives.
  • Une clé expirée, révoquée ou inconnue reçoit la même réponse, 401 invalid_api_key.
  • Créer une clé demande le rôle Propriétaire, Administrateur ou Développeur et une adresse e-mail vérifiée.
  • Propriétaires et administrateurs révoquent toute clé du projet ; un développeur révoque les siennes.

Erreurs d’authentification

Erreurs d’authentification
StatutCodeSignificationQue faire
401missing_api_keyAucune clé dans l’en-tête Authorization.Envoyez Authorization: Bearer suivi de la clé.
401invalid_api_keyClé inconnue, mal formée, expirée ou révoquée, ou projet inactif.Vérifiez la clé dans la console ou créez-en une autre.
403insufficient_scopeLa clé n’a pas l’accès exigé par cette route.Créez une clé avec cet accès.
503service_unavailableL’accès sandbox n’est pas encore ouvert aux clés de projet.Attendez l’ouverture de votre accès, sans réessayer en boucle.