API Gateway:Kunci referensi

Prasyarat

Anda telah memiliki kunci yang ada. Jika belum, buat kunci tersebut seperti dijelaskan dalam Create a key.

Mereferensikan kunci pada konsumen

1. Buka Konsol AI Gateway. Di panel navigasi sebelah kiri, pilih Consumers, lalu pilih wilayah di bilah menu atas.

2. Klik Create a consumer. Pada halaman Create Consumer, masukkan nama konsumen, atur metode autentikasi ke API key, metode generasi ke Reference Key, lalu pilih kunci yang ada untuk Bind Key.

   Catatan

   Untuk kredensial konsumen, hanya metode autentikasi API key yang mendukung referensi kunci.

Referensikan kunci dalam layanan AI

1. Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Instance. Di bilah menu atas, pilih wilayah.

2. Klik ID instans target. Di panel navigasi sebelah kiri, pilih Service, lalu klik Create Service.

3. Pada panel Create Service, atur Service Source ke AI Services. Di bagian Large Model Configuration, atur metode generasi ke Reference Key dan pilih kunci yang ada untuk API Key.

Referensikan kunci dalam layanan Agent

1. Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Instance. Di bilah menu atas, pilih wilayah.

2. Klik ID instans target. Di panel navigasi sebelah kiri, pilih Service, lalu klik Create Service.

3. Pada panel Create Service, atur Service Source ke Agent Services, Generation Method ke Reference Key, dan pilih kunci yang ada untuk API Key.

Referensikan kunci dalam layanan MCP

Layanan MCP yang diproksi langsung oleh AI Gateway mendukung autentikasi backend. Anda dapat menentukan kunci yang ada sebagai kredensial backend.

1. Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Instance. Di bilah menu atas, pilih wilayah.

2. Klik ID instans target dan buat layanan MCP untuk skenario proxy langsung seperti dijelaskan dalam Create a gateway-hosted MCP service.

3. Pada halaman detail layanan MCP, klik Configure Backend Service Authentication di bagian Basic Information untuk mengaktifkan autentikasi, lalu konfigurasikan pengaturan berikut:

   1. Authentication method: Pilih API key.

   2. Credential source: Custom HTTP Header.

   3. Header: Tentukan nama header yang membawa kredensial.

   4. Generation method: Pilih Reference Key.

   5. Credential: Pilih kunci yang ada.

Referensikan kunci dalam plugin

Gunakan sintaksis $ref{secretName} dalam konfigurasi plugin untuk mereferensikan kunci, di mana secretName adalah nama kunci tersebut. Contoh konfigurasi plugin Key-Auth:

credentials: 
# Referensikan kunci bernama secretName
- $ref{secretName}
keys:
- apikey
- x-api-key

Dengan konfigurasi ini, kunci secretName mengotentikasi akses ke AI Gateway. Plugin resmi maupun kustom sama-sama mendukung referensi kunci.

Lihat referensi kunci

Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Key. Di kolom Referenced, klik jumlah referensi kunci untuk melihat sumber daya mana saja yang menggunakannya.