Ce document décrit la procédure à suivre pour commencer à utiliser l'API Geocoding.
|
Assurez-vous de remplir les conditions préalables. |
Activez l'API dans votre projet Google Cloud. |
Configurez une clé API ou OAuth pour effectuer une requête d'API authentifiée. |
Les produits Google Maps Platform sont protégés contre les utilisations non autorisées en exigeant que les appels d'API incluent soit une clé API, soit un jeton OAuth.
Créer un jeton OAuth
L'API Geocoding est compatible avec l'utilisation d'OAuth 2.0 pour l'authentification. Google accepte les scénarios courants OAuth 2.0, tels que ceux relatifs à un serveur Web.
Ce document explique comment transmettre un jeton OAuth à l'appel de l'API Geocoding dans votre environnement de développement. Pour savoir comment utiliser OAuth dans un environnement de production, consultez Méthodes d'authentification chez Google.
À propos d'OAuth
Il existe de nombreuses façons de créer et de gérer des jetons d'accès avec OAuth en fonction de votre environnement de déploiement.
Par exemple, le système Google OAuth 2.0 est compatible avec les interactions entre serveurs, comme celles entre votre application et un service Google. Pour ce scénario, vous avez besoin d'un compte de service, qui appartient à votre application et non à un utilisateur final individuel. Votre application appelle les API Google au nom du compte de service, de sorte que les utilisateurs ne sont pas directement impliqués. Pour en savoir plus sur les méthodes d'authentification, consultez Méthodes d'authentification chez Google.
Vous pouvez également utiliser l'API Geocoding dans une application mobile Android ou iOS. Pour obtenir des informations générales sur l'utilisation d'OAuth avec l'API Geocoding, y compris sur la gestion des jetons d'accès pour différents environnements de déploiement, consultez Utiliser OAuth 2.0 pour accéder aux API Google.
À propos des habilitations OAuth
Pour utiliser OAuth avec l'API Geocoding, le jeton OAuth doit être associé au champ d'application approprié. L'API Geocoding est compatible avec les champs d'application suivants :
https://www.googleapis.com/auth/maps-platform.geocode— À utiliser avec tous les points de terminaison de l'API Geocoding.https://www.googleapis.com/auth/maps-platform.geocode.address— À utiliser uniquement avecGeocodeAddresspour le geocoding direct.https://www.googleapis.com/auth/maps-platform.geocode.location— À utiliser uniquement avecGeocodeLocationpour le geocoding inversé.https://www.googleapis.com/auth/maps-platform.geocode.place— À utiliser uniquement avecGeocodePlacepour le géocodage de lieux.
Vous pouvez également utiliser le champ d'application https://www.googleapis.com/auth/cloud-platform général pour tous les points de terminaison de l'API Geocoding. Ce champ d'application est utile pendant le développement, car il s'agit du champ d'application par défaut utilisé lors de la création de jetons à l'aide de gcloud.
Exemple : Tester des appels d'API REST dans votre environnement de développement local
Si vous souhaitez essayer l'API Geocoding à l'aide d'un jeton OAuth, mais que vous n'avez pas configuré d'environnement pour générer des jetons, vous pouvez utiliser la procédure décrite dans cette section pour effectuer l'appel.
Cet exemple décrit comment utiliser le jeton OAuth fourni par les identifiants par défaut de l'application (ADC) pour effectuer l'appel. Pour en savoir plus sur l'utilisation des ADC pour appeler des API Google à l'aide de bibliothèques clientes, consultez la page S'authentifier à l'aide de bibliothèques clientes.
Prérequis
Avant de pouvoir effectuer une requête REST à l'aide des ADC, utilisez la Google Cloud CLI pour fournir des identifiants aux ADC :
- Installez et initialisez gcloud CLI.
Exécutez la commande
gcloudsuivante sur votre machine locale pour créer votre fichier d'identifiants :gcloud auth application-default login
- Un écran de connexion s'affiche. Une fois que vous êtes connecté, vos identifiants sont stockés dans le fichier d'identifiants local utilisé par ADC.
Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local.
Effectuer une requête REST
Dans cet exemple, vous transmettez deux en-têtes de requête :
Transmettez le jeton OAuth dans l'en-tête
Authorizationà l'aide de la commande suivante pour générer le jeton :gcloud auth application-default print-access-tokenLe jeton renvoyé a une portée de
https://www.googleapis.com/auth/cloud-platform.- Transmettez l'ID ou le nom de votre projet Google Cloud pour lequel la facturation est activée dans l'en-tête
X-Goog-User-Project.
L'exemple suivant effectue un appel à l'API Geocoding à l'aide d'un jeton OAuth.
Modifiez le champ PROJECT_ID pour transmettre l'ID de votre projet Google Cloud.
curl -X GET -H 'Content-Type: application/json' \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://geocode.googleapis.com/v4beta/geocode/address/1600+Amphitheatre+Parkway,+Mountain+View,+CA"
- Cliquez sur l'icône de copie dans l'exemple de code,
,
pour copier la commande curl. - Collez la commande dans une fenêtre de terminal et exécutez-la.
La réponse est un objet JSON :
Dépannage
Si votre requête renvoie un message d'erreur indiquant que les identifiants d'utilisateur final ne sont pas compatibles avec cette API, consultez Résoudre les problèmes de configuration de vos ADC.