Semua aplikasi Google Maps Directions API memerlukan autentikasi.
- Pengguna API standar: Jika Anda menggunakan API pada standard plan, Anda harus menggunakan kunci API yang dipersiapkan dalam proyek yang Anda pilih. Lihat selengkapnya tentang kunci API untuk API standar.
Menyertakan kunci dalam permintaan akan memungkinkan Anda memantau penggunaan API aplikasi dalam Google API Console, memungkinkan akses ke kuota harian gratis yang ringan, dan memastikan Google bisa menghubungi Anda tentang aplikasi jika diperlukan.
- Pengguna Premium Plan: Jika Anda menggunakan API pada Google Maps APIs Premium Plan Anda memiliki dua opsi autentikasi:
- Gunakan kunci API yang dipersiapkan dalam proyek Google Maps APIs Premium Plan yang dibuatkan untuk Anda bila membeli Premium Plan.
atau - Sertakan ID klien dan tanda tangan digital sebagai ganti kunci API.
Lihat bagian Google Maps APIs Premium Plan di bawah ini untuk informasi mengenai pemilihan metode autentikasi terbaik.
- Gunakan kunci API yang dipersiapkan dalam proyek Google Maps APIs Premium Plan yang dibuatkan untuk Anda bila membeli Premium Plan.
Autentikasi untuk API standar — kunci API
Mendapatkan kunci API
Untuk memulai penggunaan Google Maps Directions API, klik tombol di bawah ini yang akan mengaktifkan Google Maps Directions API secara otomatis.
Dapatkan KunciAlternatifnya, ikuti langkah-langkah ini untuk mendapatkan kunci API:
- Masuklah ke Google API Console.
- Buat atau pilih sebuah proyek.
- Klik Continue untuk mengaktifkan API.
- Pada laman Credentials, dapatkan kunci API (dan setel pembatasan kunci API).
Catatan: Jika Anda memiliki kunci API tidak terbatas, atau kunci dengan pembatasan server, Anda boleh menggunakan kunci itu. - Untuk mencegah pencurian kuota, amankan kunci API Anda dengan mengikuti praktik terbaik ini.
- (Opsional) Aktifkan penagihan. Lihat Batas Penggunaan untuk informasi selengkapnya.
Anda juga bisa mencari kunci yang sudah ada di Google API Console.
Untuk informasi selengkapnya mengenai penggunaan Google API Console, lihat Bantuan API Console.
Tipe pembatasan kunci API
Google Maps API tersedia untuk aplikasi Android atau iOS, browser Web, dan melalui layanan web HTTP. API di suatu platform bisa menggunakan kunci API generik (tidak dibatasi). Secara opsional, Anda bisa menambahkan pembatasan (misalnya, alamat IP) ke kunci API. Setelah dibatasi, kunci hanya akan bekerja pada platform yang mendukung tipe pembatasan itu. Ketahui selengkapnya tentang kunci dan kredensial.
Tetapkan kunci dalam permintaan Anda
Untuk menetapkan kunci dalam permintaan Anda, sertakan sebagai nilai parameter key.
Misalnya:
https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&key=YOUR_API_KEY Autentikasi untuk pelanggan Google Maps APIs Premium Plan
Informasi di bagian ini hanya berlaku pada Google Maps APIs Premium Plan baru, yang tersedia tanggal 6 Januari 2016.
Apakah sebelumnya sudah memiliki Maps APIs for Work atau lisensi Maps API for Business? Lihat panduan Lisensi Maps APIs for Work kami. Untuk menentukan apakah Anda memiliki lisensi sebelumnya: Di Google Cloud Support Portal, klik Maps: Usage Report di sebelah kiri. Jika ID di bagian atas laporan ada dalam format berikut, berarti Anda memiliki Premium Plan baru: gme-[perusahaan] & proj-[nomor] ([tipe])
jika tidak, berarti Anda memiliki lisensi sebelumnya.
Saat menggunakan Google Maps Directions API bersama lisensi Google Maps APIs Premium Plan, Anda harus mengautentikasi aplikasi dengan kunci API atau ID klien. Sebagai tambahan, permintaan yang menggunakan ID klien juga memerlukan tanda tangan digital. Catatan: Jika Anda memiliki lisensi Maps API for Business sebelumnya, Anda harus menggunakan ID klien, bukan kunci API.
Saat memutuskan metode autentikasi yang akan digunakan, pertimbangkan yang berikut ini:
- Kunci API (tersedia untuk pelanggan Google Maps APIs Premium Plan namun tidak untuk pemegang lisensi Maps API for Business sebelumnya) — Dengan menggunakan kunci API untuk mengautentikasi permintaan, Anda bisa:
- Mengelola semua API Anda di Google API Console
- Mengakses data penggunaan real-time dan data penggunaan historis 30 hari untuk aplikasi Anda di Google API Console
- Menampilkan laporan penggunaan bersama data 30 hari lebih di Google Cloud Support Portal
- ID Klien — Dengan menggunakan ID klien (sebagai ganti kunci API) untuk mengautentikasi permintaan, Anda bisa:
- Menambahkan parameter
channelke permintaan sehingga Anda bisa menampilkan laporan penggunaan lebih detail - Menampilkan laporan penggunaan bersama data 30 hari lebih di Google Cloud Support Portal
- Menggunakan alat (bantu) Maps Analytics untuk Maps JavaScript API
- Menambahkan parameter
Dapatkan informasi selengkapnya mengenai laporan yang tersedia untuk pelanggan Premium Plan.
Menggunakan kunci API
Untuk mengautentikasi Directions API menggunakan kunci API, klik tombol di bawah ini, yang akan membawa Anda ke Google API Console dan memandu Anda menjalani prosesnya.
Penting: Dalam menu tarik-turun proyek, Anda harus memilih proyek yang telah dibuat untuk Anda saat membeli Premium Plan. Nama proyek dimulai dengan Google Maps APIs for Business or Google Maps for Work or Google Maps.*
Dapatkan KunciAlternatifnya, ikuti langkah-langkah ini untuk mendapatkan kunci API:
- Masuklah ke Google API Console.
- Dari menu tarik-turun Project, pilih proyek Google Maps Premium.*
- Klik Continue.
- Pada laman Credentials, dapatkan kunci API (dan setel pembatasan kunci API).
Catatan: Jika Anda memiliki kunci API tidak terbatas, atau kunci dengan pembatasan server, Anda boleh menggunakan kunci itu. - Untuk mencegah pencurian kuota, amankan kunci API Anda dengan mengikuti praktik terbaik ini.
* Catatan: Dalam menu tarik-turun proyek, Anda harus memilih proyek yang telah dibuat untuk Anda saat membeli Premium Plan. Nama proyek dimulai dengan Google Maps APIs for Business or Google Maps for Work or Google Maps. Penting: Jika Anda memiliki lisensi Maps API for Business sebelumnya, Anda harus menggunakan ID klien, bukan kunci API.
Anda juga bisa mencari kunci yang sudah ada di Google API Console.
Untuk informasi selengkapnya mengenai penggunaan Google API Console, lihat Bantuan API Console.
Tetapkan kunci dalam permintaan Anda
Untuk menetapkan kunci dalam permintaan Anda, sertakan sebagai nilai parameter key.
Misalnya:
https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&key=YOUR_API_KEY Menggunakan ID klien
Untuk mengautentikasi Directions API dengan menggunakan ID klien (sebagai ganti kunci API), diperlukan dua parameter autentikasi: client ID dan signature digital yang unik.
Jika sebelumnya Anda menggunakan kunci API untuk autentikasi dan beralih menggunakan ID klien, Anda harus membuang parameter key dari permintaan. Layanan web Google Maps API akan menolak permintaan yang dibuat dengan ID klien dan kunci API.
ID klien dan tanda tangan Anda
Saat pembelian lisensi Google Maps APIs Premium Plan, 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 Premium Plan. 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.
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
Saat menggunakan ID klien untuk autentikasi API, parameter opsional berikut ini dapat digunakan:
channeldigunakan untuk menyediakan detail pelaporan tambahan, dengan mengelompokkan beberapa saluran berbeda secara terpisah di laporan Anda. Lihat Ringkasan Pelaporan Premium Plan untuk informasi selengkapnya.
Tanda tangan digital
Permintaan ke Directions API oleh pelanggan Google Maps APIs Premium Plan 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 Directions API 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:
-
Buat URL permintaan tanpa tanda tangan, dengan memastikan Anda menyertakan parameter
client. Perhatikan, semua karakter non-standar perlu dienkodekan URL:https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientIDCatatan: 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.
-
Hilangkan bagian domain dari permintaan, dengan menyisakan jalur dan kueri saja.
/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID -
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. -
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.
-
Lampirkan tanda tangan ini ke URL dalam parameter
signature: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.
Untuk menandatangani URL sekarang, masukkan URL dan rahasia penandatanganan URL Anda di bawah ini. URL tersebut harus memiliki format yang dijelaskan di langkah 1 di atas, dan dienkodekan 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, Google Maps Directions 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 Premium Plan bisa memecahkan masalah URL individual dengan masuk ke Google Cloud Support Portal dan memilih Resources > Google Maps APIs Premium Plan online tools > URL Signing Debugger for Web Service and Image APIs.
