Menggunakan Skema Keamanan

Mengonfigurasi Skema Keamanan pada Tingkat Folder

Pilih folder mana pun, klik tab Auth di sebelah kanan, lalu pilih Security Scheme sebagai jenis autentikasi.

Memilih jenis autentikasi skema keamanan

Pilih Security Scheme yang diinginkan dari menu dropdown.

Jika Anda memilih OAuth 2.0 sebagai skema keamanan, Anda dapat memilih Scopes yang diperlukan lebih lanjut.

Skema keamanan yang dikonfigurasi pada tingkat folder akan berlaku untuk semua subfolder dan endpoint di bawah folder tersebut, kecuali jika subfolder atau endpoint tersebut memiliki konfigurasi autentikasinya sendiri.

Mengonfigurasi Skema Keamanan pada Tingkat Endpoint

Pilih endpoint mana pun dan buka tab Edit di sebelah kanan. Pada bagian Request, pilih Security Scheme sebagai jenis otorisasi.

Pilih Security Scheme yang diinginkan dari menu dropdown.

Memilih skema keamanan yang diinginkan untuk endpoint

Jika Anda memilih OAuth 2.0 sebagai skema keamanan, Anda dapat memilih Scopes yang diperlukan lebih lanjut.

Pengaturan Auth yang dikonfigurasi pada tingkat endpoint akan menimpa pengaturan pada tingkat folder.

Mengatur Nilai Default untuk Skema Keamanan

Skema keamanan hanya mendefinisikan metode autentikasi. Anda tetap perlu menyediakan nilai autentikasi aktual saat melakukan debugging endpoint.

Untuk menghindari pengisian nilai autentikasi secara berulang selama debugging endpoint, Apidog memungkinkan Anda mengatur nilai autentikasi default. Setelah diatur, nilai default ini digunakan secara otomatis selama debugging, kecuali ditimpa secara manual. Jika sebuah folder memiliki nilai autentikasi default yang dikonfigurasi, semua endpoint di bawahnya dapat menggunakannya.

Pilih skema keamanan dari daftar dan atur Default Auth Values.

Isi nilai berdasarkan jenis autentikasi:

API Key: Masukkan key Anda

Basic Auth: Masukkan nama pengguna dan kata sandi

Bearer Token: Masukkan token

OAuth 2.0: Masukkan client ID, client secret, dll.

Metode lain: Isi nilai yang sesuai

Mewarisi & Menyesuaikan Nilai Autentikasi

Saat menggunakan skema keamanan, Anda dapat:

1. Mewarisi dari Folder Induk

Gunakan skema keamanan dan nilai default yang didefinisikan di folder induk atau root.

2. Menyesuaikan Nilai Autentikasi

Pertahankan skema keamanan yang sama, tetapi timpa nilai default-nya.

Menggunakan Beberapa Skema Keamanan

Apidog mendukung konfigurasi beberapa skema keamanan untuk satu endpoint, yang selaras dengan mekanisme beberapa jenis autentikasi yang didefinisikan dalam spesifikasi OpenAPI:

AND: Skema keamanan yang digabungkan melalui AND harus digunakan secara bersamaan dalam permintaan yang sama (segera hadir).

OR: Skema keamanan yang digabungkan melalui OR adalah alternatif – salah satunya dapat digunakan dalam konteks yang diberikan.

Gunakan tombol + dalam pengaturan Auth untuk menambahkan lebih banyak skema keamanan.

Memilih Scope untuk Skema Keamanan OAuth 2.0

Menurut spesifikasi OpenAPI, saat membuat skema keamanan OAuth 2.0, semua Scopes yang memungkinkan harus didefinisikan. Saat menggunakannya di endpoint, Anda harus memilih scope yang diperlukan.

Untuk mempermudah, Apidog memungkinkan Anda mengatur scope default pada tingkat folder. Nilai default ini akan berlaku untuk semua endpoint dalam folder — kecuali jika Anda mengatur scope yang berbeda secara manual pada tingkat endpoint.

Dalam pengaturan Auth endpoint, pilih OAuth 2.0.

Di bawah bagian Scopes, Anda dapat melihat semua scope yang tersedia yang didefinisikan oleh skema keamanan dan memilih scope yang diperlukan.

Memilih scope autentikasi pada tingkat endpoint

Jika endpoint mewarisi scope dari folder induk, Anda dapat mengklik Reset the scopes to the configuration of the parent folder untuk mengembalikan ke konfigurasi induk.

Melakukan Debugging Endpoint dengan Skema Keamanan OAuth 2.0

Anda dapat melakukan prakonfigurasi token sebagai nilai default untuk skema keamanan OAuth 2.0, sehingga Anda tidak perlu mendapatkan token baru setiap kali melakukan debugging API.

Mendapatkan Token pada Tingkat Folder sebagai Nilai Autentikasi Default

Pilih sebuah folder, buka tab Auth, pilih skema keamanan OAuth 2.0, pilih scope dan grant type, lalu klik Get Token.

Mendapatkan token OAuth 2.0 pada tingkat folder

Dalam panel pop-up:

Masukkan client ID, client secret, dll.

Klik Continue

Setelah mendapatkan token, Anda dapat melihat detailnya, termasuk kapan token tersebut kedaluwarsa. Token ini dapat digunakan di semua endpoint dalam folder.

Mendapatkan Token pada Tingkat Endpoint sebagai Nilai Autentikasi Default

Pilih endpoint yang diinginkan, buka Edit, pilih skema keamanan OAuth 2.0, lalu klik Get Token.

Dalam panel pop-up:

Masukkan client ID, client secret, dll.

Klik Continue

Menguji skema keamanan token OAuth 2.0 pada tingkat endpoint

Selesaikan otorisasi untuk mendapatkan token

Token akan digunakan untuk debugging endpoint ini

Menggunakan Token Default atau Membuat Token Baru untuk Debugging Endpoint

Saat melakukan debugging endpoint di Apidog, Anda memiliki dua opsi untuk menerapkan token autentikasi:

Metode 1: Menggunakan Token Autentikasi Default

Saat menjalankan endpoint, buka tab Auth di bawah panel Run. Pilih Use Parent Default Auth Values. Token autentikasi default yang dikonfigurasi di folder induk akan diterapkan secara otomatis ke permintaan endpoint.

Menggunakan token autentikasi default untuk debugging endpoint

Metode 2: Membuat Token Baru

Saat menjalankan endpoint, buka tab Auth di bawah panel Run. Pilih Set Manually. Klik Get Token untuk membuka panel pembuatan token.

Membuat token baru untuk debugging endpoint

Dalam panel pop-up:

Masukkan client ID, client secret, dll.

Klik Continue

Mengisi informasi untuk membuat token baru

Selesaikan otorisasi untuk mendapatkan token

Token akan digunakan untuk debugging endpoint saat ini

Menggunakan Skema Keamanan

Mengonfigurasi Skema Keamanan pada Tingkat Folder#

Mengonfigurasi Skema Keamanan pada Tingkat Endpoint#

Mengatur Nilai Default untuk Skema Keamanan#

Mewarisi & Menyesuaikan Nilai Autentikasi#

1. Mewarisi dari Folder Induk#

2. Menyesuaikan Nilai Autentikasi#

Menggunakan Beberapa Skema Keamanan#

Memilih Scope untuk Skema Keamanan OAuth 2.0#

Melakukan Debugging Endpoint dengan Skema Keamanan OAuth 2.0#

Mendapatkan Token pada Tingkat Folder sebagai Nilai Autentikasi Default#

Mendapatkan Token pada Tingkat Endpoint sebagai Nilai Autentikasi Default#

Menggunakan Token Default atau Membuat Token Baru untuk Debugging Endpoint#

Metode 1: Menggunakan Token Autentikasi Default#

Metode 2: Membuat Token Baru#

Mengonfigurasi Skema Keamanan pada Tingkat Folder

Mengonfigurasi Skema Keamanan pada Tingkat Endpoint

Mengatur Nilai Default untuk Skema Keamanan

Mewarisi & Menyesuaikan Nilai Autentikasi

1. Mewarisi dari Folder Induk

2. Menyesuaikan Nilai Autentikasi

Menggunakan Beberapa Skema Keamanan

Memilih Scope untuk Skema Keamanan OAuth 2.0

Melakukan Debugging Endpoint dengan Skema Keamanan OAuth 2.0

Mendapatkan Token pada Tingkat Folder sebagai Nilai Autentikasi Default

Mendapatkan Token pada Tingkat Endpoint sebagai Nilai Autentikasi Default

Menggunakan Token Default atau Membuat Token Baru untuk Debugging Endpoint

Metode 1: Menggunakan Token Autentikasi Default

Metode 2: Membuat Token Baru