OAuth 2.0 adalah kerangka kerja otorisasi yang banyak digunakan, yang memungkinkan aplikasi pihak ketiga memperoleh akses terbatas ke akun pengguna pada layanan HTTP. Apidog dapat secara langsung menghasilkan token OAuth 2.0 sesuai spesifikasi dan melampirkannya ke permintaan secara otomatis, sehingga tidak perlu menghasilkan token di alat eksternal.Jenis Grant Otorisasi#
OAuth 2.0 mendukung beberapa jenis grant otorisasi, masing-masing sesuai untuk kasus penggunaan yang berbeda. Pilih jenis grant yang tepat berdasarkan persyaratan aplikasi Anda dan spesifikasi penyedia API.| Jenis Grant | Kasus Penggunaan | Keamanan | Kapan Digunakan |
|---|
| Authorization Code | Aplikasi web sisi server | Tinggi | Alur paling umum untuk aplikasi web |
| Authorization Code (With PKCE) | Aplikasi mobile/SPA | Sangat Tinggi | Keamanan yang ditingkatkan untuk klien publik |
| Implicit | Aplikasi berbasis browser (legacy) | Sedang | Tidak lagi direkomendasikan, gunakan PKCE sebagai gantinya |
| Password Credentials | Aplikasi pihak pertama tepercaya | Sedang | Pertukaran nama pengguna/kata sandi secara langsung |
| Client Credentials | Machine-to-machine | Tinggi | Autentikasi layanan-ke-layanan |
Pilih jenis grant yang sesuai dengan persyaratan penyedia API Anda. Menggunakan jenis grant yang salah akan mengakibatkan kegagalan autentikasi.
Konfigurasi: Authorization Code#
Alur Authorization Code adalah alur OAuth 2.0 yang paling aman dan paling umum digunakan untuk aplikasi web.Bidang yang Wajib Diisi#
| Bidang | Deskripsi | Sumber |
|---|
| Auth URL | URL endpoint otorisasi | Dokumentasi OAuth penyedia API |
| Access Token URL | URL endpoint token | Dokumentasi OAuth penyedia API |
| Callback URL | URI pengalihan aplikasi Anda | Aplikasi Anda (harus didaftarkan pada penyedia) |
| Client ID | Pengidentifikasi aplikasi Anda (App ID) | Konsol pengembang penyedia API |
| Client Secret | Rahasia aplikasi Anda (App Secret) | Konsol pengembang penyedia API |
Mendapatkan Token#
1.
Isi semua bidang yang wajib diisi dalam konfigurasi OAuth 2.0
3.
Halaman login akan muncul di browser Anda
4.
Selesaikan proses login dan otorisasi
5.
Halaman login akan tertutup secara otomatis
6.
Token akan diperoleh dan ditampilkan secara otomatis
Setelah berhasil memperoleh token, konten token dan masa berlakunya akan ditampilkan pada antarmuka. Ketika Anda mengklik tombol Run, token yang dihasilkan akan secara otomatis dilampirkan ke header Authorization dengan prefiks Bearer.Pemilihan Jenis Token#
Jika layanan OAuth 2.0 mengembalikan Access Token dan ID Token, Apidog akan menggunakan Access Token secara default.Untuk menggunakan ID Token sebagai gantinya, pilih ID Token pada opsi "Token Type Used". Ini berguna saat bekerja dengan implementasi OpenID Connect (OIDC).
Refresh Token#
Jika Refresh Token tersedia:Tombol Refresh Token akan muncul
Klik tombol tersebut untuk memperoleh access token baru tanpa autentikasi ulang
Tidak ada jendela login yang akan muncul
Jika Refresh Token tidak tersedia:Klik tombol Obtain Token Again
Jendela login akan muncul untuk autentikasi ulang
Mengganti Akun Login#
Halaman login OAuth 2.0 biasanya mengingat status login Anda. Untuk mengganti akun:1.
Klik tombol Clear Cookies
3.
Login dengan akun yang berbeda
Pengaturan Lanjutan#
Klik opsi Advanced untuk mengonfigurasi parameter OAuth 2.0 tambahan. Jika dibiarkan kosong, parameter tersebut akan dihasilkan secara otomatis.| Pengaturan | Deskripsi | Tujuan |
|---|
| Scope | Cakupan otorisasi | Membatasi rentang sumber daya yang akan diakses |
| State | Parameter string acak | Mencegah serangan Cross-Site Request Forgery (CSRF) |
| Credentials | Cara mengirim kredensial klien | Send as Basic Auth header atau Send client credentials in body |
| Refresh Token URL | Endpoint refresh kustom | Gunakan jika berbeda dari Access Token URL |
| HTTP Authorization Prefix | Prefiks token di header | Default adalah Bearer, sesuaikan jika diperlukan |
Selalu gunakan parameter State untuk mencegah serangan CSRF. Apidog menghasilkan parameter ini secara otomatis jika dibiarkan kosong.
FAQ#
Saat menyiapkan autentikasi OAuth2.0 untuk API Anda di Apidog, Anda mungkin perlu mendaftarkan URI pengalihan resmi di server otorisasi atau pengaturan klien Anda. Ini memastikan alur OAuth dapat diselesaikan dengan sukses dan Apidog dapat menerima access token setelah otorisasi.
✅ URI Pengalihan Resmi Apidog:Jika API Anda menggunakan OAuth2.0 Authorization Code Flow, dan Anda sedang mengonfigurasi pengaturan klien (seperti di penyedia OAuth atau Identity Platform Anda), maka Anda harus menambahkan URI ini ke bidang "Redirect URIs" atau "Callback URLs".