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 TypeKapan digunakan
noneEndpoint publik โ€” tidak perlu credential
bearerAPI yang diamankan dengan Bearer token statis
basicAPI yang menggunakan username dan password
customAPI dengan nama header kustom (mis. X-API-Key)
oauthAPI 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

FieldDeskripsi
KeyNilai token lengkap (tanpa prefix Bearer โ€” qlar menambahkannya secara otomatis)

Basic authentication

FieldDeskripsi
UsernameUsername akun
PasswordPassword akun

Custom header

FieldDeskripsi
Header NameNama HTTP header yang diharapkan API Anda (mis. X-API-Key, Authorization)
KeyNilai yang dikirimkan dalam header tersebut

OAuth 2.0 โ€” Client Credentials

FieldDeskripsi
Token URLEndpoint yang dipanggil qlar untuk mendapatkan access token
Client IDIdentifier OAuth client Anda
Client SecretSecret OAuth client Anda
ScopeDaftar OAuth scope yang dipisahkan spasi (opsional)

OAuth 2.0 โ€” Google Service Account

FieldDeskripsi
Service Account JSONIsi file kunci service account Google Anda
ScopeURL 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