Menggunakan Kunci API dengan Solar API

Produk Google Maps Platform dilindungi dari penggunaan yang tidak sah dengan membatasi panggilan API ke panggilan yang memberikan kredensial autentikasi yang tepat. Kredensial ini berbentuk kunci API - string alfanumerik unik yang mengaitkan akun penagihan Google 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 Solar API, Anda memerlukan project dengan akun penagihan dan mengaktifkan Solar API . Sebaiknya buat beberapa Pemilik Project dan Administrator Penagihan agar selalu ada seseorang yang memiliki peran ini pada tim Anda. 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 API:

Konsol

1. Buka halaman Google Maps Platform > Credentials.

   Buka halaman Credentials

2. Pada halaman Credentials, klik Create credentials > API key.
   Dialog API key created akan menampilkan kunci API yang baru dibuat.
3. Klik Close.
   Kunci API baru dicantumkan pada halaman Credentials di bawah API keys.
   (Jangan lupa untuk membatasi kunci API sebelum menggunakannya dalam produksi.)

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

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

• gcloud alpha services api-keys create

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. Untuk informasi selengkapnya, lihat Praktik terbaik keamanan API.

Saat membatasi kunci API di Konsol Cloud, Application restrictions akan menggantikan API apa pun yang diaktifkan di bagian API restrictions. Ikuti praktik terbaik dengan membuat kunci API terpisah untuk setiap aplikasi, dan untuk setiap platform yang menyediakan aplikasi tersebut.

Cara membatasi kunci API:

Konsol

1. Buka halaman Google Maps Platform > Credentials.

   Buka halaman 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 alamat IP (server web, tugas cron, dll.) dari daftar Pembatasan aplikasi. 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. Klik Batasi kunci.
2. Pilih Solar API dari menu drop-down Pilih API. Jika Solar API tidak tercantum, Anda harus mengaktifkannya.
4. Untuk menyelesaikan perubahan, klik Save.
   

Cloud SDK

Cantumkan kunci yang ada.

gcloud services api-keys list --project="PROJECT"

Hapus pembatasan yang berlaku pada kunci yang ada.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Tetapkan pembatasan baru pada kunci yang ada.

gcloud alpha services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=solar.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

Menambahkan kunci API ke permintaan

Anda harus menyertakan kunci API dengan setiap permintaan Solar API. Pada contoh berikut, ganti YOUR_API_KEY dengan kunci API Anda.

https://solar.googleapis.com/v1/buildingInsights:findClosest?location.latitude=37.2746464&location.longitude=-121.7530949&key=YOUR_API_KEY

HTTPS diperlukan untuk permintaan yang menggunakan kunci API.

Catatan: Saat menggunakan Layanan Web, semua karakter khusus di dalam parameter harus dienkode URL. URL harus dienkode dengan benar agar valid dan dibatasi hingga 2.048 karakter untuk semua layanan web. Perhatikan batas ini saat membuat URL. Browser, proxy, dan server yang berbeda juga mungkin memiliki batas karakter URL yang berbeda.