Configurer l'API Roads

Développeurs de l'Espace économique européen (EEE)

Ce document décrit les étapes à suivre pour commencer à utiliser Roads API.

Prérequis

Cette procédure vous guide dans la configuration d'un compte Google Cloud et d'un projet Google Cloud pour lequel la facturation est activée. Vous devez également savoir comment l'utilisation de Roads API vous est facturée.

  1. Consultez la facturation et les coûts d'utilisation sur la page Roads API Utilisation et facturation.

  2. Vérifiez que vous disposez d'un compte Google Cloud.

    Se connecter à la console Google Cloud

  3. Vérifiez que vous disposez d'un projet Google Cloud pour lequel la facturation est activée.

    Accéder à la page "Facturation"
    1. Sélectionnez votre projet pour ouvrir la page Facturation.

    2. Sur la page Facturation :

      • Si la facturation est déjà activée pour le projet sélectionné et que vous ne disposez que d'un seul compte de facturation, la page Facturation s'ouvre.
      • Si vous possédez plusieurs comptes de facturation, sélectionnez Accéder au compte de facturation associé pour afficher les détails du compte de facturation associé au projet.
      • Si un compte de facturation existe, mais qu'il n'est pas associé au projet, vous êtes invité à associer un compte de facturation au projet.
      • Si aucun compte de facturation n'existe ou si vous souhaitez en créer un, sélectionnez Gérer les comptes de facturation pour créer un compte de facturation. Pour en savoir plus, consultez Créer un compte de facturation Cloud en libre-service.

Activer l'API

Avant de pouvoir utiliser Roads API, vous devez l'activer dans votre projet Google Cloud à l'aide de la console Google Cloud ou de la commande gcloud.

Pour activer l'API, utilisez la commande suivante :

Console

  1. Ouvrez la page du produit dans la console Google Cloud :

    Activer Roads API

  2. Cliquez sur le bouton Activer.

gcloud

gcloud services enable \
    --project "PROJECT" \
    "roads.googleapis.com"

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

Obtenir une clé API à utiliser avec Roads API

Les produits Google Maps Platform sont protégés contre les utilisations non autorisées en exigeant que les appels d'API incluent une clé API.

Une clé API est une chaîne alphanumérique unique qui associe votre compte de facturation Cloud et votre projet Google Cloud à la requête que votre application envoie à une API ou un SDK Google Maps Platform. 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 Roads API reste sélectionné.
      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 Roads API.
      3. Cliquez sur Enregistrer.

    La sélection d'une API ici ne l'active pas. Assurez-vous que Roads API est activé sur la page de la 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=roads.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=roads.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".

Envoyer une requête API

Envoyez une requête Roads API pour renvoyer une réponse JSON qui aligne les points spécifiés sur la géométrie de la route. Vous devez inclure la chaîne alphanumérique de votre clé API dans chaque requête et utiliser HTTPS pour les requêtes qui incluent la clé API.

  1. Cliquez sur API_KEY dans le code ci-dessous pour insérer la chaîne alphanumérique de la clé :

    curl -L -X GET 'https://roads.googleapis.com/v1/snapToRoads?path=-35.27801%2C149.12958%7C-35.28032%2C149.12907%7C-35.28099%2C149.12929%7C-35.28144%2C149.12984%7C-35.28194%2C149.13003%7C-35.28282%2C149.12956%7C-35.28302%2C149.12881%7C-35.28473%2C149.12836&interpolate=true&key=YOUR_API_KEY'
  2. Cliquez sur l'icône de copie dans l'exemple de code, Sélectionnez l'icône de copie., pour copier la commande curl.
  3. Collez la commande dans une fenêtre de terminal et exécutez-la.

La réponse est un objet JSON au format suivant :

{
  "snappedPoints": [
    {
      "location": {
        "latitude": -35.278004899930188,
        "longitude": 149.129531998742
      },
      "originalIndex": 0,
      "placeId": "ChIJr_xl0GdNFmsRsUtUbW7qABM"
    },
    {
      "location": {
        "latitude": -35.2784195,
        "longitude": 149.12946589999999
      },
      "placeId": "ChIJr_xl0GdNFmsRsUtUbW7qABM"
    },
    ...
    {
      "location": {
        "latitude": -35.284727644851415,
        "longitude": 149.12833853807396
      },
      "originalIndex": 7,
      "placeId": "ChIJtWxAZmpNFmsRlbUCkc6VtnA"
    }
  ]
}

Appliquer des restrictions liées aux clés API

Google vous recommande vivement de restreindre vos clés API en limitant leur utilisation aux seules API et applications qui en ont besoin. 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. Les clés API sont compatibles avec deux types de restrictions :

  • Restrictions d'API : définissent les SDK et les API qui peuvent être appelés à l'aide de la clé API. La console et la gcloud CLI nécessitent au moins une restriction d'API lorsque vous créez une clé.
  • Les restrictions relatives aux applications spécifient les sites Web, adresses IP ou applications qui peuvent utiliser une clé API.

Pour en savoir plus sur l'application de restrictions, consultez Restreindre vos clés API.

Étape suivante

Maintenant que vous avez activé Roads API et envoyé une requête, consultez Aligner sur les routes pour en savoir plus sur l'utilisation de l'API.