Utiliser des clés API avec l'API Distance Matrix (ancienne version)

Google protège les produits Google Maps Platform contre les utilisations non autorisées en limitant les appels d'API aux personnes qui fournissent des identifiants d'authentification appropriés. Ces identifiants se présentent sous la forme d'une clé API, qui correspond à une chaîne alphanumérique unique qui associe votre compte de facturation Cloud à votre projet, ainsi qu'à l'API ou au SDK spécifique.

Ce guide explique comment créer, restreindre et utiliser votre clé API pour Google Maps Platform.

Avant de commencer

Avant de pouvoir utiliser l'API Distance Matrix (ancienne), vous devez disposer d'un projet avec un compte de facturation et l'API Distance Matrix (ancienne) doit être activée. 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é ou ajouter une API ou un SDK à une clé existante, suivez ces instructions.

Console

  1. Accédez à la page Google Maps Platform > Clés et identifiants.

    Accéder à la page "Clés et identifiants"

  2. Si vous y êtes invité, sélectionnez votre projet.

  3. Effectuez l'une des opérations suivantes :

    • Créer une clé :

      1. Cliquez sur Créer des identifiants > Clé API.
      2. Dans le panneau Créer une clé API, ouvrez la liste Sélectionner des restrictions d'API.
      3. Effacez toutes les API dont cette clé n'a pas besoin et assurez-vous que l'API Distance Matrix reste sélectionnée.
      4. Cliquez sur Créer. Le panneau affiche votre nouvelle clé API.

    • Utiliser une clé existante :

      1. Cliquez sur le nom de la clé.
      2. Dans la liste Sélectionner des restrictions d'API, sélectionnez API Distance Matrix.
      3. Cliquez sur Enregistrer.

    La sélection d'une API ici ne l'active pas. Assurez-vous que l'API Distance Matrix est activée sur la page Bibliothèque d'API.

  4. Pour afficher la chaîne de clé ultérieurement, accédez à la page Clés et identifiants, puis cliquez sur Afficher la clé pour la clé.

Si la console ne correspond pas à ces étapes, consultez Créer une clé API et Ajouter des restrictions d'API dans la documentation Google Cloud.

gcloud

Remplacez PROJECT_ID par l'ID de votre projet dans les commandes suivantes.

  • Créer une clé : exécutez la commande suivante et remplacez DISPLAY_NAME par le nom de la clé. 

    gcloud services api-keys create \
    --project="PROJECT_ID" \
    --display-name="DISPLAY_NAME" \
    --api-target=service=distance-matrix-backend.googleapis.com

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

  • Utiliser une clé existante : exécutez la commande suivante et remplacez KEY_ID par l'ID de la clé. L'option --append conserve les API que la clé autorise déjà. Sans cela, la commande les remplace.

    gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=distance-matrix-backend.googleapis.com

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

    L'ID de clé n'est pas la chaîne de clé ni le nom à afficher. Pour le trouver, exécutez gcloud services api-keys list --project="PROJECT_ID". L'ID correspond à la dernière partie du champ name : projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

Pour afficher la chaîne de clé, exécutez gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

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. Vous êtes financièrement responsable des frais occasionnés par l'utilisation abusive de clés API sans restriction. Pour en savoir plus, consultez les bonnes pratiques de sécurité pour les API.

Pour restreindre une clé API :

Console

  1. Accédez à la page Google Maps Platform > Clés et identifiants.

    Accéder à la page "Clés et 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. Pour accepter les requêtes depuis la liste d'adresses IP de serveur Web que vous fournissez, sélectionnez Adresses IP sous Restrictions relatives aux applications. À l'aide de la notation CIDR, indiquez une ou plusieurs adresses IPv4 ou IPv6, ou encore des sous-réseaux. Les adresses IP doivent correspondre à l'adresse source relevée par les serveurs de Google Maps Platform. Si vous utilisez la traduction d'adresse réseau (NAT), cette adresse correspond généralement à l'adresse IP publique de votre machine.
    • Restrictions relatives aux API :
      1. Dans Sélectionner des restrictions d'API, assurez-vous que l'API Distance Matrix est sélectionnée. Si elle ne figure pas dans la liste, vous devez l'activer.
  4. Pour valider les modifications, cliquez sur Enregistrer.

gcloud

Exécutez la commande ci-dessous. Remplacez KEY_ID par l'ID de la clé et PROJECT_ID par l'ID de votre projet. Pour trouver l'ID de la clé, exécutez gcloud services api-keys list --project="PROJECT_ID". L'ID correspond à la dernière partie du champ name.

gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=distance-matrix-backend.googleapis.com \
    --allowed-ips="IP_ADDRESS"

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

Ajouter la clé API à votre requête

Vous devez inclure une clé API dans chaque requête API Distance Matrix (ancienne). Dans l'exemple suivant, remplacez YOUR_API_KEY par votre clé API :

https://maps.googleapis.com/maps/api/distancematrix/json?origins=Seattle&destinations=San+Francisco&key=YOUR_API_KEY

Vous devez utiliser HTTPS pour les requêtes qui utilisent une clé API.