Set Authentication
Ketika beberapa API berbagi credential yang sama โ misalnya semua action yang Anda impor dari satu schema OpenAPI mengarah ke backend yang sama โ Anda dapat mengonfigurasi authentication sekali dan menerapkannya ke semuanya dalam satu langkah. Tutorial ini memandu Anda menggunakan Set Authentication pada halaman Custom API.
Kapan Menggunakan Fitur Ini
Gunakan Set Authentication ketika:
- Anda baru saja mengimpor beberapa API dari schema OpenAPI dan perlu menambahkan credential ke semuanya sekaligus
- Beberapa API yang ada pada agent Anda menggunakan token atau username/password yang sama dan Anda perlu merotasi atau memperbarui credential tersebut
- Anda ingin menerapkan atau menghapus authentication dari subset API tertentu tanpa mengedit setiap API satu per satu
Tipe Authentication yang Didukung
qlar mendukung lima metode authentication. Tabel di bawah merangkum kapan menggunakan masing-masing.
| Auth Type | Kapan digunakan |
|---|---|
none | Endpoint publik โ tidak perlu credential |
bearer | API yang diamankan dengan Bearer token statis |
basic | API yang menggunakan username dan password |
custom | API dengan nama header kustom (mis. X-API-Key) |
oauth | API yang diamankan dengan OAuth 2.0 (Client Credentials atau Google Service Account) |
Langkah 1 โ Buka Panel Set Authentication
Pada halaman Custom API, klik Set Authentication di bagian atas halaman. Sebuah sliding panel akan terbuka di sisi kanan layar.
Langkah 2 โ Konfigurasikan Authentication
Pilih Auth Type yang sesuai dengan credential API Anda. Field yang diperlukan akan muncul di bawahnya.
Bearer
Masukkan nilai token pada field Key.
Basic
Masukkan Username dan Password untuk API.
Custom
Masukkan Header Name (mis. X-API-Key) dan nilai Key. qlar akan mengirimkan Header Name: Key bersama setiap request.
OAuth
Pilih Provider Type (Client Credentials atau Google Service Account), masukkan Token URL, dan sediakan credential grant type (Client ID, Client Secret, dan scope yang diperlukan).
None
Pilih none untuk menghapus authentication dari API yang dipilih (misalnya, untuk mereset credential yang tidak lagi diperlukan).
Langkah 3 โ Pilih API yang Akan Diperbarui
Di bawah Select APIs to update, centang API yang akan menerima konfigurasi authentication ini.
Gunakan kontrol berikut untuk mempersempit atau memperluas pilihan Anda:
- Select All โ centang semua API dalam daftar
- Clear All โ hapus centang semua API dalam daftar
- Select group / Clear group โ centang atau hapus centang semua API dalam kategori tertentu
Header menampilkan berapa banyak API yang sedang dipilih.
Tip: Jika Anda baru mengimpor API dari satu schema OpenAPI, biasanya mereka akan muncul bersama. Gunakan Select group untuk grup tersebut agar dapat dikonfigurasi sekaligus.
Langkah 4 โ Terapkan Authentication
Klik OK. Dialog konfirmasi muncul yang memberi tahu Anda:
- Berapa banyak API yang akan diperbarui
- Peringatan bahwa authentication mereka saat ini akan ditimpa
Klik Confirm untuk menerapkan.
Catatan: API yang tidak Anda pilih tidak akan terpengaruh. Hanya API yang dipilih yang menerima konfigurasi authentication baru.
Langkah 5 โ Publikasikan Semua Perubahan
Klik Save all changes di bagian bawah halaman Custom API. Dialog konfirmasi akan muncul โ klik Confirm untuk mempublikasikan.
Authentication yang diperbarui kini aktif untuk semua API yang dipilih.
Referensi Detail Authentication
Bearer token
| Field | Deskripsi |
|---|---|
| Key | Nilai token lengkap (tanpa prefix Bearer โ qlar menambahkannya secara otomatis) |
Basic authentication
| Field | Deskripsi |
|---|---|
| Username | Username akun |
| Password | Password akun |
Custom header
| Field | Deskripsi |
|---|---|
| Header Name | Nama HTTP header yang diharapkan API Anda (mis. X-API-Key, Authorization) |
| Key | Nilai yang dikirimkan dalam header tersebut |
OAuth 2.0 โ Client Credentials
| Field | Deskripsi |
|---|---|
| Token URL | Endpoint yang dipanggil qlar untuk mendapatkan access token |
| Client ID | Identifier OAuth client Anda |
| Client Secret | Secret OAuth client Anda |
| Scope | Daftar OAuth scope yang dipisahkan spasi (opsional) |
OAuth 2.0 โ Google Service Account
| Field | Deskripsi |
|---|---|
| Service Account JSON | Isi file kunci service account Google Anda |
| Scope | URL scope Google API yang harus dicakup token |
Halaman Terkait
- Import OpenAPI Schema โ impor beberapa API action dari file spec, lalu gunakan Set Authentication untuk menambahkan credential
- Call API โ konfigurasikan authentication untuk satu API action
- Using Plugins โ gunakan integrasi siap pakai yang menangani authentication untuk Anda