Menggunakan Kunci API

Halaman ini menjelaskan cara menggunakan kunci API di API Gateway.

Kunci API adalah string sederhana yang mengidentifikasi projectGoogle Cloud untuk tujuan kuota, penagihan, dan pemantauan. Developer membuat kunci API dalam project di konsol Google Cloud dan menyisipkan kunci tersebut dalam setiap panggilan ke API Anda sebagai parameter kueri atau di header permintaan.

Jika Anda menentukan persyaratan kunci API di konfigurasi API, API Gateway akan menggunakan kunci API untuk mencari project Google Cloud terkait. API Gateway menolak permintaan kecuali jika kunci API dibuat di project Google Cloud atau dalam project Google Cloud lain tempat API Anda telah diaktifkan.

Catatan: Tidak seperti kredensial yang menggunakan token jangka pendek atau permintaan yang ditandatangani, kunci API berfungsi sebagai bagian dari permintaan API. Akibatnya, kunci API rentan terhadap serangan man-in-the-middle dan mungkin tidak seaman kredensial autentikasi lainnya. Anda dapat menggunakan kunci API selain salah satu bentuk autentikasi yang didukung lainnya, tetapi sebaiknya jangan gunakan hanya kunci API jika panggilan API berisi data sensitif.

Untuk membuat kunci API, atau melihat kunci API yang sudah tersedia dalam Google Cloud project, buka halaman APIs & Services > Credentials.

Buka Kredensial

Kasus penggunaan

Untuk menggunakan fitur API Gateway seperti kuota, Anda dapat meneruskan kunci API sehingga API Gateway dapat mengidentifikasi Google Cloud project yang terkait dengan aplikasi klien.

Tentang autentikasi kunci API untuk API Gateway

Jika menggunakan kunci API untuk autentikasi, Anda harus mengaktifkan dukungan kunci API terlebih dahulu untuk layanan Anda.

Masukkan perintah berikut:

gcloud services enable MANAGED_SERVICE_NAME

MANAGED_SERVICE_NAME menentukan nama layanan terkelola yang dibuat saat Anda men-deploy API. Anda dapat menemukan nama ini di kolom Managed Service untuk API Anda di halaman landing API di konsol. Atau, Anda dapat menemukan nama ini di properti Managed service saat menggunakan perintah gcloud api-gateway apis describe.

Contoh:

gcloud services enable my-api-a12bcd345e67f89g0h.apigateway.my-project.cloud.goog

Membatasi kunci API

Kunci API tidak dibatasi secara default. Kunci yang tidak dibatasi tidak aman karena dapat digunakan oleh siapa saja dari mana saja. Sebaiknya tambahkan pembatasan API jika memungkinkan. Pembatasan API menentukan API mana yang dapat dipanggil menggunakan kunci API. Semua kunci API yang digunakan oleh aplikasi produksi harus memiliki batasan API.

Untuk menambahkan pembatasan API:

1. Temukan judul API seperti yang tercantum di Konfigurasi API Anda. Dalam contoh berikut, judul API adalah My Example Config:

   # openapi.yaml
   swagger: '2.0'
   info:
     title: My Example Config
     description: Sample API on API Gateway
     version: 1.0.0
   ...

2. Di konsol Google Cloud, buka halaman APIs & Services > Credentials.

   Buka Kredensial

3. Pilih nama kunci API yang ingin Anda gunakan untuk API.

4. Di bagian API restrictions pada halaman detail kunci API, klik Restrict key.

5. Pilih API yang akan digunakan oleh kunci API Anda dari daftar dropdown API yang tersedia. Misalnya, jika menggunakan contoh konfigurasi di atas, pilih My Example Config.

6. Klik Save.

Pembatasan Anda akan segera diterapkan.