Menggunakan Kunci API

Halaman ini menjelaskan cara menggunakan kunci API di Gateway API.

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

Jika Anda menetapkan persyaratan kunci API dalam konfigurasi API, Gateway API akan menggunakan kunci API untuk mencari project Google Cloud yang terkait. Gateway API menolak permintaan kecuali jika kunci API dibuat di project Google Cloud Anda atau dalam project Google Cloud lain yang mengaktifkan API Anda.

Catatan: Tidak seperti kredensial yang menggunakan token berumur pendek atau permintaan bertanda tangan, 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 kunci API hanya jika panggilan API berisi data sensitif.

Untuk membuat kunci API, atau melihat kunci API yang sudah tersedia dalam project Google Cloud, buka halaman API & Layanan > Kredensial.

Buka Kredensial

Kasus penggunaan

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

Tentang autentikasi kunci API untuk Gateway API

Jika menggunakan kunci API untuk autentikasi, Anda harus terlebih dahulu mengaktifkan dukungan kunci API 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 Layanan Terkelola untuk API pada halaman landing API dalam 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 API restrictions jika memungkinkan. Pembatasan API menentukan API mana yang dapat dipanggil menggunakan kunci API. Semua kunci API yang digunakan oleh aplikasi produksi harus memiliki pembatasan API.

Untuk menambahkan pembatasan API:

1. Temukan judul API seperti yang tercantum dalam 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 digunakan untuk API Anda.

4. Di bagian API restrictions di 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 Simpan.

Pembatasan Anda akan diterapkan sementara.