Autentikasi dan Otorisasi

Laman ini hanya untuk pelanggan yang memiliki lisensi sebelumnya dari Maps APIs for Work atau lisensi Maps API for Business. Laman ini tidak berlaku untuk pelanggan yang memiliki Google Maps APIs Premium Plan baru, yang tersedia pada Januari 2016.

ID klien dan tanda tangan

Saat menggunakan layanan web Google Maps APIs dengan lisensi Google Maps APIs for Work, diperlukan dua parameter autentikasi: client ID dan signature digital yang unik (sebagai ganti kunci API).

Jika Anda beralih dari layanan web API gratis ke implementasi Google Maps APIs for Work, Anda harus membuang parameter key dari permintaan. Layanan web Google Maps APIs akan mengabaikan permintaan yang dibuat dengan ID klien maupun kunci.

ID klien dan tanda tangan Anda

Saat pembelian lisensi Google Maps APIs for Work, Anda akan menerima email sambutan dari Google yang berisi ID klien dan kunci kriptografik privat.

  • ID klien Anda digunakan untuk mengakses fitur spesial Google Maps APIs for Work—Anda harus menyediakan ID klien saat mengakses pustaka API atau layanan. Semua ID klien yang diawali dengan awalan gme-. Teruskan ID klien Anda sebagai nilai parameter client.

  • Tanda tangan digital unik dihasilkan menggunakan kunci kriptografik privat Anda. Teruskan tanda tangan ini sebagai nilai parameter signature. Anda bisa menemukan informasi selengkapnya tentang menghasilkan tanda tangan di bawah ini, di bagian tanda tangan digital.

Inilah contoh Google Maps Directions API:

    https://maps.googleapis.com/maps/api/directions/json
      ?origin=Toronto
      &destination=Montreal
      &client=gme-YOUR_CLIENT_ID
      &signature=YOUR_URL_SIGNATURE

Jika Anda kehilangan ID klien atau kunci kriptografik privat, Anda bisa memulihkannya dengan masuk ke Google Cloud Support Portal dan mengeklik Maps: Manage Client ID dari tautan di kiri laman.

Parameter opsional untuk laporan

Selain parameter autentikasi, parameter berikut opsional pada permintaan Google Maps APIs for Work:

  • channel digunakan untuk menyediakan detail pelaporan tambahan, dengan mengelompokkan beberapa saluran berbeda secara terpisah di laporan Anda. Lihat bagian Laporan saluran layanan web Google Maps APIs for Work dokumen Kuota dan Pelaporan.

Tanda tangan digital

Permintaan ke Web Service API oleh pelanggan Google Maps APIs for Work memerlukan signature digital, yang dihasilkan menggunakan kunci kriptografik privat yang disediakan untuk Anda dalam email sambutan.

Proses penandatanganan menggabungkan URL dan kunci dengan menggunakan algoritme enkripsi. Tanda tangan unik yang dihasilkan memungkinkan server kami memverifikasi apakah situs yang menghasilkan permintaan dengan menggunakan ID klien Anda memang telah diotorisasi untuk melakukannya. Tanda tangan tersebut juga bersifat unik untuk setiap URL, sehingga memastikan permintaan yang menggunakan ID klien Anda tidak bisa dimodifikasi tanpa mengharuskan pembuatan tanda tangan baru.

Kunci kriptografik privat Anda

Kunci penandatanganan URL kriptografik privat Anda akan dikeluarkan bersama ID klien Anda dan merupakan "kunci bersama rahasia" antara Anda dan Google. Kunci penandatanganan ini adalah milik Anda sendiri dan bersifat unik terhadap ID klien Anda. Karena alasan itu, amankan kunci penandatanganan Anda. Kunci ini tidak boleh diteruskan dalam permintaan, disimpan di situs web, atau diposkan ke forum publik. Siapa pun yang memperoleh kunci penandatanganan ini akan bisa memalsukan permintaan dengan menggunakan identitas Anda.

Catatan: Kunci penandatanganan kriptografik privat ini tidak sama dengan kunci API yang dikeluarkan oleh Google API Console.

Jika Anda kehilangan kunci kriptografik privat, masuklah ke Google Cloud Support Portal dan klik Maps: Manage Client ID untuk mengambilnya.

Membuat tanda tangan digital

Upaya untuk mengakses layanan web Google Maps APIs dengan tanda tangan yang tidak valid akan mengakibatkan kesalahan HTTP 403 (Forbidden). Saat mengonversi aplikasi Anda untuk menggunakan penanda tangan URL, pastikan menguji tanda tangan Anda untuk memastikan tanda tangan itu memulai permintaan yang valid. Terlebih dahulu Anda harus menguji apakah URL asal memang valid serta menguji apakah Anda menghasilkan tanda tangan yang benar.

Ikuti langkah-langkah ini untuk membuat tanda tangan digital bagi permintaan Anda:

  1. Buat URL permintaan tanpa tanda tangan, dengan memastikan Anda menyertakan parameter client. Perhatikan, semua karakter non-standar perlu dienkodekan URL. Misalnya, untuk Directions API, buat URL seperti berikut:

    https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID

    Catatan: Semua layanan Google memerlukan pengkodean karakter UTF-8 (yang secara implisit menyertakan ASCII). Jika aplikasi Anda beroperasi menggunakan set karakter lain, pastikan URL dibuat dengan menggunakan UTF-8 dan mengenkodenya ke URL dengan benar.

  2. Hilangkan bagian domain dari permintaan, dengan menyisakan jalur dan kueri saja. Misalnya, untuk Directions API:

    /maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID

  3. Ambil kunci privat Anda, yang telah dienkode dalam Base64 modifikasi untuk URL, dan menandatangani URL di atas menggunakan algoritme HMAC-SHA1. Anda mungkin perlu mendekode kunci ini ke dalam format biner asalnya. Perhatikan, di hampir semua pustaka kriptografik, tanda tangan hasilnya dalam format biner.

    Catatan: Base64 yang dimodifikasi untuk URL akan mengganti karakter + dan / standar Base64 dengan - dan _, sehingga semua tanda tangan Base64 tidak perlu lagi dienkode ke URL.

  4. Kodekan tanda tangan biner yang dihasilkan dengan menggunakan Base64 yang dimodifikasi untuk URL guna mengonversi tanda tangan ini menjadi sesuatu yang bisa diteruskan dalam URL.

  5. Lampirkan tanda tangan ini ke URL dalam parameter signature. Misalnya, untuk Directions API:

    https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID&signature=base64signature

Untuk contoh yang menampilkan cara mengimplementasikan penandatanganan URL menggunakan kode sisi-server, lihat Kode contoh untuk penandatanganan URL.

Kode contoh untuk penandatanganan URL

Bagian berikut ini menunjukkan cara mengimplementasikan penandatanganan URL menggunakan kode server-side. URL harus selalu ditandatangani server-side untuk mencegah kunci kriptografik Anda bisa dilihat pengguna.

Python

Contoh di bawah ini menggunakan pustaka Python standar untuk menandatangani URL. (Unduh kode.)

#!/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

Contoh di bawah ini menggunakan kelas java.util.Base64 yang tersedia sejak JDK 1.8 - versi lama mungkin perlu menggunakan Apache Commons atau yang serupa. (Unduh kode.)

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#

Contoh di bawah ini menggunakan pustaka System.Security.Cryptography default untuk menandatangani permintaan URL. Perhatikan, kita perlu mengonversi pengkodean Base64 default untuk mengimplementasikan versi URL-aman. (Unduh kode.)

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));
    }
  }
}

Untuk keperluan pengujian, Anda bisa menguji URL dan kunci privat berikut untuk mengetahui apakah menghasilkan tanda tangan yang benar. Perhatikan, kunci privat ini semata-mata untuk keperluan pengujian dan tidak akan divalidasi oleh layanan Google.

  • URL: https://maps.googleapis.com/maps/api/geocode/json?address=New+York&client=clientID
  • Kunci Privat: vNIXE0xscrmjlyV-12Nj_BvUPaw=
  • Porsi URL untuk Ditandatangani: /maps/api/geocode/json?address=New+York&client=clientID
  • Tanda Tangan: chaRF2hTJKOScPr-RQCEhZbSzIE=
  • URL Bertandatangan Penuh: https://maps.googleapis.com/maps/api/geocode/json?address=New+York&client=clientID&signature=chaRF2hTJKOScPr-RQCEhZbSzIE=

Contoh dalam bahasa tambahan

Contoh yang membahas bahasa lainnya tersedia di proyek url-signing.

Memecahkan masalah autentikasi

Jika permintaan Anda salah format atau memberikan tanda tangan yang tidak valid, Web Service API akan mengembalikan kesalahan HTTP 403 (Forbidden).

Untuk memecahkan setiap masalah URL, Anda bisa menggunakan URL Signing Debugger. Alat bantu ini memungkinkan Anda memvalidasi URL dan tanda tangan yang dihasilkan oleh aplikasi Anda.

Sebagai alternatif, pelanggan Google Maps APIs for Work bisa memecahkan masalah URL individual dengan masuk ke Google Cloud Support Portal dan memilih Resources > Google Maps online tools > URL Signing Debugger for Web Service and Image APIs.