API Geocoding : obtenir une clé API

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

Choisir une méthode d'authentification

Pour utiliser Google Maps Platform, vous devez authentifier les requêtes à l'aide d'une clé API ou d'un ID client et d'une signature numérique.

Vous choisissez la méthode d'authentification selon votre licence :

  • Les clients disposant du forfait Premium peuvent utiliser une clé API ou un ID client et une signature numérique.
  • Les clients qui disposent d'une licence antérieure doivent utiliser un ID client et une signature numérique.

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

  • Authentification via une clé API (forfait Premium)
    En utilisant une clé API pour authentifier votre requête, vous pouvez :
    • gérer toutes vos API sur la page des API de Google Cloud Console ;
    • accéder à des données d'utilisation en temps réel et à un historique des données d'utilisation sur les 30 derniers jours sur la page des API de Cloud Console ;
    • ajouter le paramètre channel aux requêtes afin d'obtenir des rapports plus détaillés sur l'utilisation ;
    • afficher des rapports d'utilisation avec plus de 30 jours de données dans Google Cloud Console ;
  • Authentification via un ID client et une signature numérique (forfait Premium ou licence antérieure).
    En utilisant votre ID client et votre signature numérique pour authentifier votre requête, vous pouvez :
    • ajouter le paramètre channel aux requêtes afin d'obtenir des rapports plus détaillés sur l'utilisation ;
    • afficher des rapports d'utilisation avec plus de 30 jours de données dans Cloud Console ;
    • utiliser les outils Maps Analytics pour l'API Maps JavaScript.

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

Authentification via une clé API

Obtenir la clé API

La clé API est un identifiant unique qui permet d'authentifier les requêtes associées à votre projet à des fins d'utilisation et de facturation.

Pour obtenir une clé API :

  1. Dans Cloud Console, 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 votre forfait Premium, vous devez utiliser le projet associé à votre 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 d'accéder au bon projet, connectez-vous à la console en tant que propriétaire du projet sur console.cloud.google.com/project/number (remplacez number par votre numéro de projet). Le nom du propriétaire du projet est indiqué dans votre courrier 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 Google Maps Platform. Dans l'exemple suivant, remplacez YOUR_API_KEY par votre clé API.

https://maps.googleapis.com/maps/api/geocode/json?address=1600+Amphitheatre+Parkway,+Mountain+View,+CA&key=YOUR_API_KEY

Restreindre les clés API

Restreindre les clés API permet de renforcer la sécurité de votre application, car vous vous assurez 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 les bonnes pratiques concernant les clés API.

Pour restreindre une clé API :

  1. Accédez à la page API et services > 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 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. Sélectionnez Google Maps Platform dans la liste déroulante Sélectionner des API. Si Google Maps Platform ne figure pas dans la liste, vous devez l'activer.
  4. Pour valider les modifications, cliquez sur Enregistrer.

Authentification via un ID client et une signature numérique

Lorsque vous achetez votre licence du forfait Premium Google Maps Platform, vous recevez un e-mail de bienvenue de la part de Google. Il contient votre ID client et votre clé cryptographique privée (qui vous permet de générer une signature numérique unique).

L'exemple de code ci-dessous illustre les paramètres client et signature, auxquels vous devez transmettre votre ID client et votre signature numérique unique.

    https://maps.googleapis.com/maps/api/geocode/json
      ?address=1600+Amphitheatre+Parkway,+Mountain+View,+CA
      &client=YOUR_CLIENT_ID
      &signature=SIGNATURE
  • Remplacez YOUR_CLIENT_ID par l'ID client contenu dans l'e-mail de bienvenue.

    Cet ID commence par les caractères gme-.

  • Remplacez SIGNATURE par votre signature numérique unique (consultez Générer une signature numérique).

Remarques :

  • Si vous le souhaitez, vous pouvez utiliser le paramètre channel lorsque vous authentifiez Google Maps Platform via un ID client et une signature numérique pour recevoir des rapports détaillés sur l'utilisation. Pour en savoir plus, consultez Présentation des rapports du forfait Premium.
  • Si vous utilisiez auparavant une clé API pour l'authentification et que vous souhaitez désormais utiliser un ID client, vous devez supprimer le paramètre key de vos requêtes. Les services Web des API Google Maps refuseront les requêtes contenant à la fois un ID client et une clé API.

Générer une signature numérique

Les requêtes adressées à l'API Geocoding par les clients du forfait Premium Google Maps Platform nécessitent une signature numérique. Vous pouvez la générer à l'aide de la clé cryptographique privée qui vous a été fournie dans votre e-mail de bienvenue (voir Autres informations sur votre clé cryptographique privée).

Suivez les étapes ci-dessous afin de générer une signature numérique pour votre requête.

  1. Créez l'URL de 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/geocode/json?address=1600+Amphitheatre+Parkway,+Mountain+View,+CA&client=clientID

    Remarque : Tous les services Google nécessitent l'encodage 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 encodent 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/geocode/json?address=1600+Amphitheatre+Parkway,+Mountain+View,+CA&client=clientID

  3. Récupérez votre clé privée, encodée au format 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 est générée au format binaire.

    Remarque : Le format Base64 modifié pour les URL remplace respectivement les caractères + et / (Base64 standard) par les caractères - et _. Notez que ces signatures Base64 n'ont donc plus besoin d'être encodées en URL.

  4. Encodez la signature binaire générée à l'aide du format Base64 modifié pour les URL afin de la convertir en élément pouvant être transmis dans une URL.

  5. Associez cette signature à l'URL dans un paramètre signature :

    https://maps.googleapis.com/maps/api/geocode/json?address=1600+Amphitheatre+Parkway,+Mountain+View,+CA&client=clientID&signature=base64signature

Remarques :

  • La signature unique 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. Elle est également propre à chaque URL, afin de garantir que les requêtes qui utilisent votre ID client ne peuvent être modifiées qu'à condition qu'une autre signature soit générée.
  • Toute tentative d'accès à l'API Geocoding avec une signature non valide générera une erreur HTTP 403 (Refusé). Lorsque vous convertissez vos applications pour utiliser la signature d'URL, pensez à tester vos signatures afin de vérifier qu'elles envoient une requête valide. Vous devez d'abord tester si l'URL d'origine est valide et si les signatures générées sont correctes.
  • Pour des exemples de mise en œuvre de la signature d'URL avec le code côté serveur, consultez Exemple de code de signature d'URL.

Pour signer une URL, saisissez votre URL et votre signature secrète d'URL ci-dessous. L'URL doit être au format décrit à l'étape 1 ci-dessus et encodée en URL.

Exemple de code pour la signature d'URL

Les sections suivantes expliquent comment mettre en œuvre la signature d'URL à l'aide du code côté serveur. Vous devez toujours signer les URL côté serveur afin de ne pas dévoiler votre clé cryptographique aux utilisateurs.

Python

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

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

import hashlib
import hmac
import base64
import urllib.parse as 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, str.encode(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.decode()

if __name__ == "__main__":
    input_url = input("URL to Sign: ")
    secret = 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 JDK 1.8. Les versions plus anciennes auront peut-être besoin d'Apache Commons ou similaire. (Téléchargez 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;
  }
}

Node.js

L'exemple ci-dessous utilise des modules Node natifs pour signer une URL. (Téléchargez le code.)

'use strict'

const crypto = require('crypto');
const url = require('url');

/**
 * Convert from 'web safe' base64 to true base64.
 *
 * @param  {string} safeEncodedString The code you want to translate
 *                                    from a web safe form.
 * @return {string}
 */
function removeWebSafe(safeEncodedString) {
  return safeEncodedString.replace(/-/g, '+').replace(/_/g, '/');
}

/**
 * Convert from true base64 to 'web safe' base64
 *
 * @param  {string} encodedString The code you want to translate to a
 *                                web safe form.
 * @return {string}
 */
function makeWebSafe(encodedString) {
  return encodedString.replace(/\+/g, '-').replace(/\//g, '_');
}

/**
 * Takes a base64 code and decodes it.
 *
 * @param  {string} code The encoded data.
 * @return {string}
 */
function decodeBase64Hash(code) {
  // "new Buffer(...)" is deprecated. Use Buffer.from if it exists.
  return Buffer.from ? Buffer.from(code, 'base64') : new Buffer(code, 'base64');
}

/**
 * Takes a key and signs the data with it.
 *
 * @param  {string} key  Your unique secret key.
 * @param  {string} data The url to sign.
 * @return {string}
 */
function encodeBase64Hash(key, data) {
  return crypto.createHmac('sha1', key).update(data).digest('base64');
}

/**
 * Sign a URL using a secret key.
 *
 * @param  {string} path   The url you want to sign.
 * @param  {string} secret Your unique secret key.
 * @return {string}
 */
function sign(path, secret) {
  const uri = url.parse(path);
  const safeSecret = decodeBase64Hash(removeWebSafe(secret));
  const hashedSignature = makeWebSafe(encodeBase64Hash(safeSecret, uri.path));
  return url.format(uri) + '&signature=' + hashedSignature;
}

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 l'encodage Base64 par défaut pour mettre en œuvre une version sécurisée pour les URL. (Téléchargez 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 essayer d'utiliser l'URL et la clé privée suivantes pour vérifier qu'elles génèrent la bonne signature. Notez que cette clé privée n'est destinée qu'aux tests 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 langages sont disponibles dans le projet url-signing.

Autres informations sur votre clé cryptographique privée

Votre clé cryptographique privée de signature d'URL sera générée avec votre ID client. Elle 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. Vous devez donc la maintenir en sécurité. Cette clé ne doit en aucun cas être transmise dans une requête, stockée sur un site Web ou publiée sur un forum public. Toute personne qui obtient cette clé de signature est susceptible d'envoyer des requêtes en usurpant votre identité.

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

Si vous avez perdu votre clé cryptographique privée, connectez-vous à Cloud Console et cliquez sur Maps: Manage Client ID (Maps : gérer l'ID client) pour la récupérer.

Résoudre les problèmes d'authentification

Si le format de votre requête est incorrect ou fournit une signature non valide, Google Maps Platform affiche une erreur HTTP 403 (Forbidden).

Pour résoudre les problèmes liés à des URL spécifiques, 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 à Cloud Console, puis en sélectionnant Resources > Google Maps Platform Premium Plan online tools > URL Signing Debugger for Web Service and Image APIs (Ressources > Outils en ligne du forfait Premium Google Maps Platform > URL Signing Debugger pour les API Web Service et Image).