Utiliser des clés API

Sélectionnez une plate-forme : Android iOS JavaScript Services Web

Avant de commencer

Avant de commencer à utiliser le SDK Places pour Android, vous devez disposer d'un projet avec un compte de facturation et le SDK Places pour Android activé. Pour en savoir plus, consultez Configurer vos projets dans la console Cloud.

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 figure sur la page Identifiants sous Clés API.
    (N'oubliez pas de restreindre la clé API avant de l'utiliser en production.)

Cloud SDK

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

En savoir plus sur le Google Cloud SDK, l'installation du Cloud SDK 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 vous aide à renforcer la sécurité de votre application en la protégeant contre les requêtes non justifiées. Pour en savoir plus, consultez les bonnes pratiques de sécurité pour les 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 un build.

Pour en savoir plus sur les certificats et la signature d'application Android, consultez le guide Signer votre application.

Pour savoir comment trouver l'empreinte du certificat de signature, consultez les références ci-dessous :

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 API Places ou API Places (New). dans le menu déroulant Sélectionner des API, mais pas les deux. Si l'API Places ne figure pas dans la liste, vous devez l'activer.
  4. Pour valider les modifications, cliquez sur Enregistrer.

SDK Cloud

SDK Places pour Android (nouveau)

Listez les clés existantes. 

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

Supprimez 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="places.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

SDK Places pour Android

Listez les clés existantes. 

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

Supprimez 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="places-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

Étapes suivantes

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