API Roads : obtenir une clé API

Remarque : Il n'est plus possible de s'inscrire au forfait Premium Google Maps Platform, et il n'est plus disponible non plus pour les nouveaux clients.

Pour utiliser Roads API, vous devez authentifier les requêtes à l'aide d'une clé API. En utilisant une clé API, vous pouvez :

  • gérer toutes vos API dans la console Google Cloud Platform ;
  • accéder à des données d'utilisation en temps réel et à un historique des données d'utilisation sur les 30 derniers jours dans la console Google Cloud Platform ;
  • ajouter le paramètre channel aux requêtes afin de pouvoir afficher des rapports plus détaillés sur l'utilisation ;
  • afficher des rapports sur l'utilisation avec plus de 30 jours de données dans le portail d'assistance Google Cloud.

En savoir plus sur les rapports disponibles pour les clients du forfait Premium

Créer des clés API

Pour utiliser Roads API, vous devez disposer d'une clé API. La clé API est un identifiant unique qui permet d'authentifier les requêtes associées à votre projet afin de déterminer l'utilisation et la facturation.

Pour obtenir une clé API, procédez comme suit :

  1. Dans la console GCP, sur la page du sélecteur de projet, sélectionnez ou créez un projet Google Cloud pour lequel vous souhaitez ajouter une clé API.

    Accéder à la page du sélecteur de projet

    Remarque : Pour bénéficier d'un accès complet aux fonctionnalités de leur forfait, les clients Premium doivent utiliser le projet associé à leur compte Premium. Lorsque vous avez acheté votre licence, vous avez reçu le nom de l'élément Premium au format suivant : gme-[company] & proj-[number] ([type]). Pour vous assurer que vous accédez au bon projet, connectez-vous à la console en tant que propriétaire du projet à l'adresse console.cloud.google.com/project/number (remplacez number par votre numéro de projet). Vous trouverez le propriétaire du projet dans la lettre de bienvenue.

  2. Accédez à la page API et services > Identifiants.

    Accéder à la page "Identifiants"

  3. 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.
  4. 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.)

Ajouter la clé API à votre requête

Vous devez inclure une clé API dans chaque requête Roads API. Dans l'exemple suivant, remplacez YOUR_API_KEY par votre clé API.

https://roads.googleapis.com/v1/snapToRoads?path=-35.27801,149.12958|-35.28032,149.12907|-35.28099,149.12929|-35.28144,149.12984|-35.28194,149.13003|-35.28282,149.12956|-35.28302,149.12881|-35.28473,149.12836 &interpolate=true &key=YOUR_API_KEY

Restreindre les clés API

La restriction des clés API renforce la sécurité de votre application en garantissant que seules les requêtes autorisées sont effectuées avec votre clé API. Nous vous recommandons vivement de suivre les instructions pour définir des restrictions au niveau de vos clés API. Pour en savoir plus, consultez la page Bonnes pratiques concernant les clés API.

Pour restreindre une clé API, procédez comme suit :

  1. Dans la console GCP, sur la page du sélecteur de projet, sélectionnez ou créez un projet Google Cloud pour lequel vous souhaitez ajouter une clé API.

    Accéder à la page du sélecteur de projet

  2. Accédez à la page API et services > Identifiants.

    Accéder à la page "Identifiants"

  3. 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.
  4. Sous Restrictions relatives aux clés, définissez les restrictions suivantes :
    • Restrictions relatives aux applications :
      1. Pour accepter les requêtes de la liste des adresses IP de serveurs Web que vous fournissez, sélectionnez Adresses IP (serveurs Web, tâches Cron, etc.) dans la liste des restrictions relatives aux applications.
      2. Spécifiez une adresse IPv4 ou IPv6, ou un sous-réseau au format CIDR (192.168.0.0/22, par exemple). Si vous devez saisir une autre entrée, une nouvelle zone apparaît dès que vous avez fini d'ajouter l'entrée précédente.
    • Restrictions relatives aux API :
      1. Cliquez sur Restreindre la clé.
      2. Dans la liste déroulante Sélectionner des API, sélectionnez Roads API.
        (Si Roads API n'est pas répertorié, vous devez l'activer.)
  5. Pour finaliser vos modifications, cliquez sur Enregistrer.

Résoudre les problèmes d'authentification

Si votre requête est mal définie ou intègre une signature non valide, Roads API renvoie une erreur HTTP 403 (Forbidden).

Pour résoudre les problèmes liés aux URL, utilisez l'outil URL Signing Debugger. Il vous permet de valider rapidement les URL et les signatures générées par votre application.

Les clients du forfait Premium peuvent également résoudre les problèmes liés aux URL en se connectant au portail d'assistance Google Cloud, puis en sélectionnant Ressources > Outils en ligne du forfait Premium Google Maps Platform > URL Signing Debugger pour les API Web Service et Image.