Menggunakan kunci API dengan Distance Matrix API (Lama)

Google melindungi produk Google Maps Platform dari penggunaan yang tidak sah dengan membatasi panggilan API ke panggilan yang memberikan kredensial autentikasi yang tepat. Kredensial ini berbentuk kunci API, yang merupakan string alfanumerik unik yang mengaitkan akun Penagihan Cloud dengan project Anda dan dengan API atau SDK tertentu.

Panduan ini menunjukkan cara membuat, membatasi, dan menggunakan kunci API untuk Google Maps Platform.

Sebelum memulai

Sebelum mulai menggunakan Distance Matrix API (Lama), Anda harus memiliki project dengan akun penagihan dan Distance Matrix API (Lama) yang aktif. Untuk mempelajari lebih lanjut, lihat Menyiapkan project di Konsol Cloud.

Membuat kunci API

Kunci API adalah ID unik yang mengautentikasi permintaan terkait project untuk tujuan penggunaan dan penagihan. Anda harus memiliki setidaknya satu kunci API terkait project. Untuk membuat kunci baru atau menambahkan API atau SDK ke kunci yang ada, ikuti petunjuk berikut.

Konsol

  1. Buka halaman Google Maps Platform > Keys & Credentials.

    Buka halaman Keys & Credentials

  2. Jika diminta, pilih project Anda.

  3. Lakukan salah satu hal berikut:

    • Buat kunci baru:

      1. Klik Create credentials > API key.
      2. Di panel Buat kunci API, buka daftar Pilih batasan API.
      3. Hapus API yang tidak diperlukan oleh kunci ini, dan pastikan Distance Matrix API tetap dipilih.
      4. Klik Buat. Panel akan menampilkan kunci API baru Anda.

    • Menggunakan kunci yang ada:

      1. Klik nama kunci.
      2. Dalam daftar Select API restrictions, pilih Distance Matrix API.
      3. Klik Simpan.

    Memilih API di sini tidak akan mengaktifkannya. Pastikan Distance Matrix API diaktifkan di halaman Library API.

  4. Untuk melihat string kunci nanti, buka halaman Keys & Credentials, lalu klik Show key untuk kunci tersebut.

Jika konsol terlihat berbeda dari langkah-langkah ini, lihat Membuat kunci API dan Menambahkan pembatasan API dalam dokumentasi Google Cloud.

gcloud

Ganti PROJECT_ID dengan project ID Anda dalam perintah berikut.

  • Buat kunci baru: Jalankan perintah berikut, dan ganti DISPLAY_NAME dengan nama untuk kunci. 

    gcloud services api-keys create \
    --project="PROJECT_ID" \
    --display-name="DISPLAY_NAME" \
    --api-target=service=distance-matrix-backend.googleapis.com

    Baca selengkapnya tentang Google Cloud SDK, Penginstalan Cloud SDK, dan perintah berikut:

  • Gunakan kunci yang ada: Jalankan perintah berikut, dan ganti KEY_ID dengan ID kunci. Flag --append mempertahankan API yang sudah diizinkan oleh kunci. Tanpa parameter ini, perintah akan menggantinya.

    gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=distance-matrix-backend.googleapis.com

    Baca selengkapnya tentang Google Cloud SDK, Penginstalan Cloud SDK, dan perintah berikut:

    ID kunci bukanlah string kunci atau nama tampilan. Untuk menemukannya, jalankan gcloud services api-keys list --project="PROJECT_ID". ID adalah bagian terakhir dari kolom name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

Untuk melihat string kunci, jalankan gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

Membatasi kunci API

Google sangat menyarankan agar Anda membatasi penggunaan kunci API hanya untuk API yang diperlukan aplikasi Anda. Membatasi kunci API akan meningkatkan keamanan aplikasi Anda dengan melindunginya dari permintaan yang tidak sah. Anda bertanggung jawab secara finansial atas tagihan yang disebabkan oleh penyalahgunaan kunci API yang tidak dibatasi. Untuk informasi selengkapnya, lihat Praktik terbaik keamanan API.

Cara membatasi kunci API:

Konsol

  1. Buka halaman Google Maps Platform > Keys & Credentials.

    Buka halaman Keys & Credentials

  2. Pilih kunci API yang ingin Anda batasi. Halaman properti kunci API akan muncul.
  3. Di bagian Key restrictions, tetapkan pembatasan berikut:
    • Pembatasan aplikasi:
      1. Untuk menerima permintaan dari daftar alamat IP server web yang Anda berikan, pilih IP addresses di bagian Application restrictions. Tentukan satu atau beberapa alamat IPv4 atau IPv6, atau subnet menggunakan notasi CIDR. Alamat IP harus cocok dengan alamat sumber yang diamati oleh server Google Maps Platform. Jika Anda menggunakan penafsiran alamat jaringan (NAT), alamat ini biasanya sesuai dengan alamat IP publik komputer Anda.
    • Pembatasan API:
      1. Di Select API restrictions, pastikan Distance Matrix API dipilih. Jika tidak tercantum, Anda harus mengaktifkannya.
  4. Untuk menyelesaikan perubahan, klik Save.

gcloud

Jalankan perintah berikut. Ganti KEY_ID dengan ID kunci dan PROJECT_ID dengan project ID Anda. Untuk menemukan ID kunci, jalankan gcloud services api-keys list --project="PROJECT_ID". ID adalah bagian terakhir dari kolom name.

gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=distance-matrix-backend.googleapis.com \
    --allowed-ips="IP_ADDRESS"

Baca selengkapnya tentang Google Cloud SDK, Penginstalan Cloud SDK, dan perintah berikut:

Menambahkan kunci API ke permintaan

Anda harus menyertakan kunci API bersama setiap permintaan Distance Matrix API (Lama). Pada contoh berikut, ganti YOUR_API_KEY dengan kunci API Anda:

https://maps.googleapis.com/maps/api/distancematrix/json?origins=Seattle&destinations=San+Francisco&key=YOUR_API_KEY

Anda harus menggunakan HTTPS untuk permintaan yang menggunakan kunci API.