Utiliser des clés API avec l'API Time Zone

Les produits Google Maps Platform sont protégés contre les utilisations non autorisées en limitant les appels d'API à ceux 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 Google à 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 Time Zone, vous devez disposer d'un projet avec un compte de facturation et l'API Time Zone activée. 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 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 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.

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. Pour accepter les requêtes d'une liste d'adresses IP de serveurs Web que vous fournissez, sélectionnez Adresses IP (serveurs Web, tâches Cron, etc.) dans la liste Restrictions relatives aux applications. Spécifiez une adresse IPv4 ou IPv6, ou un sous-réseau au format CIDR (192.168.0.0/22, par exemple). Étant donné qu'une requête de service Web vérifie et compare l'adresse IP externe à la restriction de clé API, utilisez l'adresse IP publique du serveur.
    • Restrictions relatives aux API :
      1. Cliquez sur Restreindre la clé.
      2. Sélectionnez API Time Zone dans la liste déroulante Sélectionner des API. Si l'API Time Zone n'est pas répertoriée, vous devez l'activer.
  4. Pour valider les modifications, cliquez sur Enregistrer.

Cloud SDK

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="timezone-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 de l'API Time Zone. Dans l'exemple suivant, remplacez YOUR_API_KEY par votre clé API.

https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510&timestamp=1331161200&key=YOUR_API_KEY

HTTPS est requis pour les requêtes qui utilisent une clé API.