Utiliser des clés API

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Sélectionnez une plate-forme : Android iOS JavaScript

Cette rubrique explique comment créer une clé API pour le SDK Maps pour Android, l'ajouter à votre application et sécuriser cette dernière en limitant la clé. Vous devez ajouter une clé API à toute application qui utilise le SDK.

Avant de commencer

Pour utiliser le SDK Maps pour Android, vous devez disposer d'un projet associé à un compte de facturation et vous devez activer le SDK Maps pour Android. Pour en savoir plus, consultez Configurer vos projets dans Cloud Console.

Créer des clés API

Une clé API est un identifiant unique qui permet d'authentifier les requêtes associées à votre projet à des fins d'utilisation et de facturation. Vous devez associer au moins une clé API à votre projet.

Pour créer une clé API :

Console

  1. Accédez à la page Google Maps Platform > Identifiants.

    Accéder à la page "Identifiants"

  2. Sur la page Identifiants, cliquez sur Créer des identifiants > Clé API.
    La boîte de dialogue Clé API créée affiche la clé API que vous venez de créer.
  3. Cliquez sur Fermer.
    La nouvelle clé API est répertoriée sur la page Identifiants sous Clés API.
    (N'oubliez pas de restreindre la clé API avant de l'utiliser en production.)

SDK Cloud

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

En savoir plus sur le SDK Google Cloud, l'installation du SDK Cloud et les commandes suivantes :

Restreindre les clés API

Google vous recommande vivement de restreindre vos clés API en limitant leur utilisation aux seules API nécessaires à votre application. Restreindre les clés API permet de renforcer la sécurité de votre application, en la protégeant contre les requêtes non garanties. Pour en savoir plus, consultez les bonnes pratiques concernant les clés API.

Lorsque vous restreignez votre clé API, vous devez fournir l'empreinte du certificat SHA-1 de la clé de signature utilisée pour signer l'application. Il existe deux types de certificats :

  • Certificat de débogage : n'utilisez ce type de certificat qu'avec des applications que vous testez et d'autres codes hors production. N'essayez pas de publier une application signée avec un certificat de débogage. Les outils Android SDK génèrent ce certificat automatiquement lorsque vous exécutez une version de débogage.
  • Certificat de version : utilisez ce certificat lorsque vous êtes prêt à publier votre application sur une plate-forme de téléchargement d'applications. Les SDK Tools pour Android génèrent ce certificat lorsque vous exécutez une version de production.

Pour en savoir plus sur les certificats numériques, consultez le guide Signer votre application.

Pour savoir comment obtenir votre empreinte de certificat, consultez Authentifier votre client. Si vous utilisez plutôt la signature d'application Play, vous devez accéder à la page de signature d'application sur la Play Console pour obtenir votre empreinte de certificat.

Pour restreindre une clé API :

Console

  1. Accédez à la page Google Maps Platform > Identifiants.

    Accéder à la page "Identifiants"

  2. Sélectionnez la clé API pour laquelle vous souhaitez définir une restriction. La page des propriétés de la clé API s'affiche.
  3. Sous Restrictions relatives aux clés, définissez les restrictions suivantes :
    • Restrictions relatives aux applications :
      1. Sélectionnez Applications Android.
      2. Cliquez sur + Ajouter le nom du package et l'empreinte.
      3. Saisissez le nom du package et l'empreinte du certificat SHA-1. Exemple :
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • Restrictions relatives aux API :
      1. Cliquez sur Restreindre la clé.
      2. Sélectionnez SDK Maps pour Android dans le menu déroulant Sélectionner des API. Si le SDK Maps pour Android n'est pas répertorié, vous devez l'activer.
  4. Pour valider les modifications, cliquez sur Enregistrer.

SDK Cloud

Répertoriez les clés existantes.

gcloud services api-keys list --project="PROJECT"

Supprimer les restrictions existantes sur la clé existante.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Définissez de nouvelles restrictions pour la clé existante.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api_target="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

En savoir plus sur le SDK Google Cloud, l'installation du SDK Cloud et les commandes suivantes :

Étapes suivantes

Maintenant que vous disposez d'une clé API, créez et configurez un projet comme décrit dans Configurer un projet Android Studio.