Komponen otentikasi kunci API menyediakan autentikasi berbasis kunci API. Komponen ini mengekstraksi kunci API dari parameter URL, header permintaan, atau cookie dalam permintaan HTTP, lalu membandingkannya dengan daftar kredensial yang telah dikonfigurasi sebelumnya untuk memverifikasi izin akses.
Jenis fitur
Autentikasi
Field
ComponentConfig
Parameter | Type | Wajib | Bawaan | Deskripsi |
Config | Ya | - | Konfigurasi otentikasi kunci API. |
ApiKeyConfig
Parameter | Tipe | Wajib | Bawaan | Deskripsi |
ApiKeySources | Ya | - | Metode untuk mengekstrak kunci API dari permintaan. Hanya satu sumber yang didukung. | |
ApiKeyCredentials | Ya | - | Daftar kredensial kunci API tepercaya. |
ApiKeySourcesConfig
Parameter | Tipe | Wajib | Bawaan | Deskripsi |
Headers | String[] | Tidak | - | Mengekstrak kunci API dari header permintaan HTTP. |
Params | String[] | Tidak | - | Mengekstrak kunci API dari parameter URL. |
Cookies | String[] | Tidak | - | Mengekstrak kunci API dari cookie. |
ApiKeyCredential
Parameter | Tipe | Wajib | Bawaan | Deskripsi |
Provider | Ya | System | Jenis kredensial. | |
Credential | String | Wajib bersyarat | - | Nilai kredensial, yaitu string kunci API. |
ApiKeyCredentialProvider
Nilai | Deskripsi |
System | Kredensial yang dihasilkan secara otomatis oleh sistem. |
Custom | Kredensial yang diunggah oleh pengguna. |
Kode error
Kode status HTTP | Pesan error | Deskripsi |
401 | Client authentication failed. | Otentikasi kunci API gagal. Hal ini dapat terjadi karena kunci salah atau kunci API tidak disediakan. |