Vous êtes prêt !

Pour passer à l'étape de développement, accédez à notre documentation pour les développeurs.

Activer Google Maps Elevation API

Pour commencer, nous allons vous guider à travers la console Google Developers et effectuer deux ou trois petites choses :

  1. Créer ou sélectionner un projet
  2. Activer Google Maps Elevation API
  3. Créer les clés appropriées
Continuer

Obtenir une clé/authentification

Toutes les applications Google Maps Elevation API requièrent une authentification.

  • Utilisateurs de l'API standard : Si vous utilisez l'API dans le cadre du plan Standard, vous devez utiliser une clé d'API configurée dans le projet de votre choix. En savoir plus sur les clés d'API pour l'API standard.

    Inclure une clé dans votre requête vous permet de surveiller l'utilisation de l'API par votre application dans Google API Console et d'accéder à un généreux quota journalier gratuit. Ce paramètre permet également à Google de vous contacter à propos de votre application, le cas échéant.

  • Utilisateurs Premium Plan : Si vous utilisez l'API avec Google Maps APIs Premium Plan, vous disposez de deux options d'authentification :
    • Utilisez une clé d'API configurée dans le projet Google Maps APIs Premium Plan (créé pour vous lorsque vous avez acheté Premium Plan).
        ou
    • Incluez un ID client et une signature numérique à la place de la clé d'API.

    Pour plus d'informations sur le choix de la meilleure méthode d'authentification, voir la section Google Maps APIs Premium Plan ci-dessous.

Authentification pour l'API standard — Clés d'API

Obtenir une clé d'API

Pour commencer à utiliser Google Maps Elevation API, cliquez sur le bouton ci-dessous qui active Google Maps Elevation API automatiquement.

Obtenir une clé

Vous pouvez également obtenir une clé d'API comme suit :

  1. Allez à la Google API Console.
  2. Créez ou sélectionnez un projet.
  3. Cliquez sur Continue pour activer l'API.
  4. Sur la page Credentials, procurez-vous une clé d'API (et définissez les restrictions de clé d'API).
    Remarque : Si vous possédez une clé d'API sans restriction ou une clé avec des restrictions de serveur, vous pouvez l'utiliser.
  5. Pour éviter le vol de quota, sécurisez votre clé d'API conformément aux meilleures pratiques suivantes.
  6. (facultatif) Activez la facturation. Pour plus d'informations, voir Limites d'utilisation.


Vous pouvez également rechercher une clé existante dans la Google API Console.

Pour plus d'informations sur l'utilisation de la Google API Console, voir l'aide de la API Console.

Types de restrictions de clé d'API

Les Google Maps API sont disponibles pour les applications Android ou iOS, les navigateurs Web et via les services Web HTTP. Sur toute plateforme, les API peuvent utiliser une clé d'API générique (sans restriction). Vous pouvez éventuellement ajouter une restriction (par exemple, adresse IP) à la clé d'API. Une fois restreinte, la clé fonctionne uniquement sur les plateformes qui prennent en charge ce type de restriction. En savoir plus sur les clés et les identifiants.

Spécifier une clé dans votre requête

Pour spécifier une clé dans votre requête, intégrez-la sous la forme d'une valeur de paramètre key.

Par exemple :

https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536,-104.9847034&key=YOUR_API_KEY

Authentification pour les clients Google Maps APIs Premium Plan

Les informations de cette section s'appliquent uniquement au nouveau Google Maps APIs Premium Plan, disponible à partir du 6 janvier 2016.

Vous possédez une ancienne licence Maps APIs for Work ou Maps API for Business ? Consultez notre guide des licences Maps APIs for Work. Pour déterminer si vous avez une ancienne licence : Dans le Google Cloud Support Portal, cliquez sur Maps: Usage Report sur la gauche. Si l'ID en haut du rapport est au format suivant, cela signifie que vous disposez de la nouvelle licence Premium Plan :
gme-[company] & proj-[number] ([type])
Sinon, cela signifie que vous avez une licence antérieure.

Lorsque vous utilisez Google Maps Elevation API avec une licence Google Maps APIs Premium Plan, vous devez authentifier votre application avec une clé d'API ou votre ID client. En outre, les requêtes utilisant un ID client nécessitent également une signature numérique. Remarque : Si vous disposez d'une licence Maps API for Business antérieure, vous devez utiliser un ID client et non pas une clé d'API.

Pour décider de la méthode d'authentification à utiliser, prenez en compte les informations suivantes :

  • Clé d'API (disponible pour les clients Google Maps APIs Premium Plan mais pas pour les titulaires d'une licence Maps API for Business antérieure) — En utilisant une clé d'API pour authentifier les requêtes, vous pouvez :
    • Gérer toutes vos API dans la Google API Console
    • Accéder en temps réel aux données d'utilisation et à un historique des données d'utilisation sur les 30 derniers jours pour votre application dans la Google API Console
    • Afficher des rapports d'utilisation avec plus de 30 jours de données dans le Google Cloud Support Portal
  • ID client — En utilisant votre ID client (au lieu d'une clé d'API) pour authentifier les requêtes, vous pouvez :
    • Ajouter le paramètre channel aux requêtes afin d'afficher des rapports d'utilisation plus détaillés
    • Afficher des rapports d'utilisation avec plus de 30 jours de données dans le Google Cloud Support Portal
    • Utiliser les outils Maps Analytics pour Maps JavaScript API

En savoir plus sur les rapports disponibles pour les clients Premium Plan.

Utiliser une clé d'API

Pour authentifier l'API de Elevation à l'aide d'une clé d'API, cliquez sur le bouton ci-dessous qui vous redirige vers la Google API Console et vous fournit de l'aide tout au long du processus.

Important : Dans le menu déroulant du projet, sélectionnez le projet créé pour vous lors de l'achat de Premium Plan. Le nom du projet commence par Google Maps APIs for Business or Google Maps for Work or Google Maps.*

Obtenir une clé

Vous pouvez également obtenir une clé d'API comme suit :

  1. Allez à la Google API Console.
  2. Dans le menu déroulant Project, sélectionnez le projet Google Maps Premium.*
  3. Cliquez sur Continue.
  4. Sur la page Credentials, procurez-vous une clé d'API (et définissez les restrictions de clé d'API).
    Remarque : Si vous possédez une clé d'API sans restriction ou une clé avec des restrictions de serveur, vous pouvez l'utiliser.
  5. Pour éviter le vol de quota, sécurisez votre clé d'API conformément aux meilleures pratiques suivantes.

* Remarque : Dans le menu déroulant du projet, vous devez sélectionner le projet créé pour vous lors de l'achat de Premium Plan. Le nom du projet commence par Google Maps APIs for Business or Google Maps for Work or Google Maps. Important : Si vous disposez d'une licence Maps API for Business antérieure, vous devez utiliser un ID client et non pas une clé d'API.


Vous pouvez également rechercher une clé existante dans la Google API Console.

Pour plus d'informations sur l'utilisation de la Google API Console, voir l'aide de la API Console.

Spécifier une clé dans votre requête

Pour spécifier une clé dans votre requête, intégrez-la sous la forme d'une valeur de paramètre key.

Par exemple :

https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536,-104.9847034&key=YOUR_API_KEY

Utiliser un ID client

Pour authentifier l'API de Elevation à l'aide d'un ID client (au lieu d'une clé d'API), deux paramètres d'authentification sont requis : un ID client et une signature numérique unique.

Si vous utilisiez précédemment une clé d'API pour l'authentification et que vous allez désormais utiliser un ID client, vous devez supprimer le paramètre key de vos requêtes. Les services Web Google Maps API refuseront les requêtes contenant à la fois un ID client et une clé d'API.

Votre ID client et votre signature

Lors de l'achat de votre licence Google Maps APIs Premium Plan, vous recevrez de la part de Google un e-mail de bienvenue contenant votre ID client et votre clé cryptographique privée.

  • Votre ID client permet d'accéder aux fonctionnalités spéciales de Google Maps APIs Premium Plan. Tous les ID client commencent par le préfixe gme-. Indiquez votre ID client comme valeur du paramètre client.

  • Une signature numérique unique est générée à l'aide de votre clé cryptographique privée. Renseignez cette signature comme valeur du paramètre signature. Vous trouverez plus d'informations sur la génération d'une signature ci-dessous, dans la section sur les signatures numériques.

    https://maps.googleapis.com/maps/api/elevation/json
      ?locations=39.7391536,-104.9847034
      &client=YOUR_CLIENT_ID
      &signature=SIGNATURE

En cas d'oubli de votre ID client ou de votre clé cryptographique privée, vous pouvez le(la) récupérer en vous connectant au Google Cloud Support Portal et en cliquant sur Maps: Manage Client ID à partir des liens se trouvant à gauche de la page.

Paramètre facultatif pour les rapports

Lorsque vous utilisez un ID client pour l'authentification de l'API, le paramètre facultatif suivant peut être utilisé :

Signatures numériques

Les requêtes vers Elevation API par les clients Google Maps APIs Premium Plan nécessitent une signature numérique, générée à l'aide de la clé cryptographique privée qui vous a été communiquée dans votre e-mail de bienvenue.

Le processus de signature associe une URL et la clé au moyen d'un algorithme de chiffrement. La signature unique qui en résulte permet à nos serveurs de vérifier que tous les sites qui génèrent des requêtes à l'aide de votre ID client sont autorisés à le faire. La signature est également unique au niveau d'une URL, afin de garantir que les requêtes qui utilisent votre ID client ne puissent être modifiées sans exiger la création d'une autre signature.

Votre clé cryptographique privée

Votre clé cryptographique privée de signature d'URL sera émise avec votre ID client et correspond à une « clé secrète partagée » entre vous et Google. Cette clé de signature n'appartient qu'à vous et est spécifique à votre ID client. Votre clé de signature doit donc être conservée en lieu sûr. Cette clé ne doit pas être transmise dans une requête, stockée sur un site Web, ni publiée sur un forum public. Quiconque obtient cette clé de signature peut envoyer des requêtes en utilisant votre identité.

Remarque : Cette clé de signature cryptographique privée est différente des clés d'API émises par la Google API Console.

En cas de perte de votre clé cryptographique privée, connectez-vous au Google Cloud Support Portal et cliquez sur Maps: Manage Client ID pour la récupérer.

Générer une signature numérique

Toute tentative d'accès à Elevation API avec une signature non valide renverra une erreur HTTP 403 (Forbidden). Lors de la conversion de vos applications pour l'utilisation de la signature d'URL, pensez à tester vos signatures pour vérifier qu'elles envoient une requête valide. Vous devez au préalable tester si l'URL d'origine est valide et tester si les signatures générées sont correctes.

Procédez comme suit pour créer une signature numérique pour votre requête :

  1. Construisez l'URL de la requête sans la signature, en veillant à inclure le paramètre client. Notez que tout caractère non standard devra être encodé en URL :

    https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536,-104.9847034&client=clientID

    Remarque : Tous les services Google nécessitent le codage de caractères UTF-8 (qui inclut implicitement ASCII). Si vos applications utilisent d'autres jeux de caractères, veillez à ce qu'elles créent les URL au format UTF-8 et les codent en URL de manière appropriée.

  2. Supprimez la partie domaine de la requête pour ne conserver que le chemin et la demande :

    /maps/api/elevation/json?locations=39.7391536,-104.9847034&client=clientID

  3. Récupérez votre clé privée, encodée en Base64 modifié pour les URL, et signez l'URL ci-dessus à l'aide de l'algorithme HMAC-SHA1. Vous devrez peut-être décoder cette clé dans son format binaire d'origine. Notez que dans la plupart des bibliothèques cryptographiques, la signature sera générée au format binaire.

    Remarque : Le format Base64 modifié pour les URL remplace les caractères + et / du format Base64 standard par les caractères - et _, respectivement. Ces signatures Base64 n'ont donc plus besoin d'être codées en URL.

  4. Codez la signature binaire générée à l'aide du format Base64 modifié pour les URL afin de la convertir de sorte à être incluse dans une URL.

  5. Associez cette signature à l'URL au sein d'un paramètre signature :

    https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536,-104.9847034&client=clientID&signature=base64signature

Pour des exemples de mise en œuvre de la signature d'URL à l'aide du code côté serveur, voir Exemple de code de signature d'URL.

Pour signer une URL maintenant, saisissez votre URL et votre secret de signature d'URL ci-dessous. L'URL doit avoir le format décrit à l'étape 1 ci-dessus et doit être encodée en URL.

Exemple de code de signature d'URL

Les sections suivantes expliquent comment mettre en œuvre la signature d'URL à l'aide du code côté serveur. Les URL doivent toujours être signées côté serveur afin de masquer votre clé cryptographique aux utilisateurs.

Python

L'exemple ci-dessous utilise les bibliothèques Python standard pour signer une URL. (Télécharger le code.)

#!/usr/bin/python
# -*- coding: utf-8 -*-
""" Signs a URL using a URL signing secret """

import hashlib
import hmac
import base64
import urlparse

def sign_url(input_url=None, secret=None):
  """ Sign a request URL with a URL signing secret.

      Usage:
      from urlsigner import sign_url

      signed_url = sign_url(input_url=my_url, secret=SECRET)

      Args:
      input_url - The URL to sign
      secret    - Your URL signing secret

      Returns:
      The signed request URL
  """

  if not input_url or not secret:
    raise Exception("Both input_url and secret are required")

  url = urlparse.urlparse(input_url)

  # We only need to sign the path+query part of the string
  url_to_sign = url.path + "?" + url.query

  # Decode the private key into its binary format
  # We need to decode the URL-encoded private key
  decoded_key = base64.urlsafe_b64decode(secret)

  # Create a signature using the private key and the URL-encoded
  # string using HMAC SHA1. This signature will be binary.
  signature = hmac.new(decoded_key, url_to_sign, hashlib.sha1)

  # Encode the binary signature into base64 for use within a URL
  encoded_signature = base64.urlsafe_b64encode(signature.digest())

  original_url = url.scheme + "://" + url.netloc + url.path + "?" + url.query

  # Return signed URL
  return original_url + "&signature=" + encoded_signature

if __name__ == "__main__":
  input_url = raw_input("URL to Sign: ")
  secret = raw_input("URL signing secret: ")
  print "Signed URL: " + sign_url(input_url, secret)

Java

L'exemple ci-dessous utilise la classe java.util.Base64 disponible depuis la version JDK 1.8 (les versions plus anciennes pourront avoir besoin d'Apache Commons ou similaire). (Télécharger le code.)

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;  // JDK 1.8 only - older versions may need to use Apache Commons or similar.
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class UrlSigner {

  // Note: Generally, you should store your private key someplace safe
  // and read them into your code

  private static String keyString = "YOUR_PRIVATE_KEY";
  
  // The URL shown in these examples is a static URL which should already
  // be URL-encoded. In practice, you will likely have code
  // which assembles your URL from user or web service input
  // and plugs those values into its parameters.
  private static String urlString = "YOUR_URL_TO_SIGN";

  // This variable stores the binary key, which is computed from the string (Base64) key
  private static byte[] key;
  
  public static void main(String[] args) throws IOException,
    InvalidKeyException, NoSuchAlgorithmException, URISyntaxException {
    
    BufferedReader input = new BufferedReader(new InputStreamReader(System.in));
    
    String inputUrl, inputKey = null;

    // For testing purposes, allow user input for the URL.
    // If no input is entered, use the static URL defined above.    
    System.out.println("Enter the URL (must be URL-encoded) to sign: ");
    inputUrl = input.readLine();
    if (inputUrl.equals("")) {
      inputUrl = urlString;
    }
    
    // Convert the string to a URL so we can parse it
    URL url = new URL(inputUrl);
 
    // For testing purposes, allow user input for the private key.
    // If no input is entered, use the static key defined above.   
    System.out.println("Enter the Private key to sign the URL: ");
    inputKey = input.readLine();
    if (inputKey.equals("")) {
      inputKey = keyString;
    }
    
    UrlSigner signer = new UrlSigner(inputKey);
    String request = signer.signRequest(url.getPath(),url.getQuery());
    
    System.out.println("Signed URL :" + url.getProtocol() + "://" + url.getHost() + request);
  }
  
  public UrlSigner(String keyString) throws IOException {
    // Convert the key from 'web safe' base 64 to binary
    keyString = keyString.replace('-', '+');
    keyString = keyString.replace('_', '/');
    System.out.println("Key: " + keyString);
    // Base64 is JDK 1.8 only - older versions may need to use Apache Commons or similar.
    this.key = Base64.getDecoder().decode(keyString);
  }

  public String signRequest(String path, String query) throws NoSuchAlgorithmException,
    InvalidKeyException, UnsupportedEncodingException, URISyntaxException {
    
    // Retrieve the proper URL components to sign
    String resource = path + '?' + query;
    
    // Get an HMAC-SHA1 signing key from the raw key bytes
    SecretKeySpec sha1Key = new SecretKeySpec(key, "HmacSHA1");

    // Get an HMAC-SHA1 Mac instance and initialize it with the HMAC-SHA1 key
    Mac mac = Mac.getInstance("HmacSHA1");
    mac.init(sha1Key);

    // compute the binary signature for the request
    byte[] sigBytes = mac.doFinal(resource.getBytes());

    // base 64 encode the binary signature
    // Base64 is JDK 1.8 only - older versions may need to use Apache Commons or similar.
    String signature = Base64.getEncoder().encodeToString(sigBytes);
    
    // convert the signature to 'web safe' base 64
    signature = signature.replace('+', '-');
    signature = signature.replace('/', '_');
    
    return resource + "&signature=" + signature;
  }
}

C#

L'exemple ci-dessous utilise la bibliothèque System.Security.Cryptography par défaut pour signer une requête d'URL. Notez que nous devons convertir le codage Base64 par défaut pour pouvoir mettre en œuvre une version d'URL sécurisée. (Télécharger le code.)

using System;
using System.Collections.Generic;
using System.Security.Cryptography;
using System.Text;
using System.Text.RegularExpressions;
using System.Web;

namespace SignUrl {

  public struct GoogleSignedUrl {

    public static string Sign(string url, string keyString) {
      ASCIIEncoding encoding = new ASCIIEncoding();

      // converting key to bytes will throw an exception, need to replace '-' and '_' characters first.
      string usablePrivateKey = keyString.Replace("-", "+").Replace("_", "/");
      byte[] privateKeyBytes = Convert.FromBase64String(usablePrivateKey);

      Uri uri = new Uri(url);
      byte[] encodedPathAndQueryBytes = encoding.GetBytes(uri.LocalPath + uri.Query);

      // compute the hash
      HMACSHA1 algorithm = new HMACSHA1(privateKeyBytes);
      byte[] hash = algorithm.ComputeHash(encodedPathAndQueryBytes);

      // convert the bytes to string and make url-safe by replacing '+' and '/' characters
      string signature = Convert.ToBase64String(hash).Replace("+", "-").Replace("/", "_");
            
      // Add the signature to the existing URI.
      return uri.Scheme+"://"+uri.Host+uri.LocalPath + uri.Query +"&signature=" + signature;
    }
  }

  class Program {

    static void Main() {
    
      // Note: Generally, you should store your private key someplace safe
      // and read them into your code

      const string keyString = "YOUR_PRIVATE_KEY";
  
      // The URL shown in these examples is a static URL which should already
      // be URL-encoded. In practice, you will likely have code
      // which assembles your URL from user or web service input
      // and plugs those values into its parameters.
      const  string urlString = "YOUR_URL_TO_SIGN";
      
      string inputUrl = null;
      string inputKey = null;
    
      Console.WriteLine("Enter the URL (must be URL-encoded) to sign: ");
      inputUrl = Console.ReadLine();
      if (inputUrl.Length == 0) {
        inputUrl = urlString;
      }     
    
      Console.WriteLine("Enter the Private key to sign the URL: ");
      inputKey = Console.ReadLine();
      if (inputKey.Length == 0) {
        inputKey = keyString;
      }
      
      Console.WriteLine(GoogleSignedUrl.Sign(inputUrl,inputKey));
    }
  }
}

À des fins de test, vous pouvez tester l'URL et la clé privée suivantes pour voir si elles génèrent la bonne signature. Notez que cette clé privée est destinée uniquement à des fins de test et ne sera validée par aucun service Google.

  • URL : https://maps.googleapis.com/maps/api/geocode/json?address=New+York&client=clientID
  • Clé privée : vNIXE0xscrmjlyV-12Nj_BvUPaw=
  • Partie d'URL à signer : /maps/api/geocode/json?address=New+York&client=clientID
  • Signature : chaRF2hTJKOScPr-RQCEhZbSzIE=
  • URL complète signée : https://maps.googleapis.com/maps/api/geocode/json?address=New+York&client=clientID&signature=chaRF2hTJKOScPr-RQCEhZbSzIE=

Exemples dans d'autres langages

Des exemples dans d'autres langues sont disponibles dans le projet de signature d'URL.

Résolution des problèmes d'authentification

Si votre requête est mal définie ou intègre une signature non valide, Google Maps Elevation 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.

Par ailleurs, les clients Google Maps APIs Premium Plan peuvent résoudre les problèmes liés aux URL en se connectant au Google Cloud Support Portal et en sélectionnant Resources > Google Maps APIs Premium Plan online tools > URL Signing Debugger for Web Service and Image APIs.

Envoyer des commentaires concernant…

Google Maps Elevation API
Google Maps Elevation API
Besoin d'aide ? Consultez notre page d'assistance.