[Panduan] Dasar-Dasar URL Callback Postman

Dalam ranah pengembangan dan pengujian API, Postman berdiri sebagai alat yang ampuh. Kemampuannya untuk merampingkan alur kerja dan menyederhanakan interaksi dengan API tidak dapat disangkal. Namun, fungsionalitas tertentu, seperti otorisasi OAuth 2.0, bergantung pada mekanisme penting yang dikenal sebagai URL Callback.

Artikel ini membahas konsep URL callback Postman, menjelaskan peran mereka dalam proses autentikasi dan bagaimana mereka berkontribusi pada pengalaman pengembangan API yang lancar.

Apa itu URL Callback?

Dalam ranah aplikasi web dan API, komunikasi tidak selalu mengalir dalam satu arah. Seringkali, sebuah aplikasi atau layanan perlu mengirim informasi kembali setelah menyelesaikan tugas atau tindakan yang dimulai oleh sistem lain.

Di sinilah URL callback berperan. Mereka bertindak sebagai alamat pengembalian yang ditunjuk, menentukan lokasi web tertentu tempat respons atau pembaruan dapat dikirim.

Bagaimana Cara Kerja URL Callback?

Langkah 1 - Memulai Tindakan

Bayangkan Anda menggunakan aplikasi web untuk mengunggah file video besar untuk diproses. Aplikasi mengirimkan permintaan ke server yang berisi data dan instruksi video.

Langkah 2 - Waktu Pemrosesan yang Lama

Memproses video mungkin membutuhkan waktu yang signifikan. Server tidak dapat begitu saja menahan koneksi terbuka menunggu aplikasi Anda untuk memeriksa kembali penyelesaian.

Langkah 3 - Menentukan URL Callback

Di sinilah URL callback berperan. Anda, sebagai pengguna, memberikan server dengan alamat web tertentu (URL callback) di dalam aplikasi Anda. Ini memberi tahu server ke mana harus mengirim pemberitahuan setelah pemrosesan selesai.

Langkah 4 - Mengirim Respons

Ketika pemrosesan selesai, server mengirimkan respons yang berisi informasi tentang hasil (misalnya, berhasil atau gagal, detail pemrosesan) ke URL callback yang telah ditentukan sebelumnya di aplikasi Anda.

Langkah 5 - Menerima Pemberitahuan

Aplikasi Anda tidak perlu terus-menerus memeriksa pembaruan. Ia menerima pemberitahuan secara otomatis di URL callback yang ditunjuk, memungkinkan Anda untuk diberi tahu tentang penyelesaian dan detail relevan apa pun.

Postman dan URL Callback

Postman memanfaatkan URL callback untuk merampingkan proses otorisasi OAuth 2.0, standar yang banyak digunakan untuk memberikan akses ke API.

Apa itu OAuth 2.0?

OAuth 2.0 adalah kerangka kerja otorisasi yang memungkinkan pengguna untuk memberikan akses ke akun mereka di satu platform (misalnya, Google) ke aplikasi lain (misalnya, aplikasi khusus) tanpa membagikan kata sandi mereka secara langsung. Ini memastikan cara yang aman dan terkontrol bagi aplikasi untuk mengakses data pengguna.

Peran URL Callback dalam OAuth 2.0

Alur otorisasi OAuth 2.0 biasanya melibatkan beberapa langkah:

1. Otorisasi Pengguna: Aplikasi mengarahkan pengguna ke server otorisasi (misalnya, halaman login Google).
2. Pemberian Izin: Pengguna masuk dan memberikan izin aplikasi untuk mengakses data tertentu.
3. Kode Otorisasi: Server otorisasi mengembalikan kode otorisasi ke URL callback yang telah dikonfigurasi sebelumnya dari aplikasi.

Proses URL Callback Postman

Menentukan URL Callback

Di dalam Postman, Anda mengonfigurasi URL callback yang diinginkan untuk aplikasi Anda. URL ini dapat berupa alamat lokal yang khusus untuk Postman (disediakan oleh Postman itu sendiri) atau URL yang dapat diakses publik untuk aplikasi Anda yang sebenarnya.

Menyadap Kode

Ketika server otorisasi mengarahkan pengguna kembali dengan kode otorisasi, Postman, alih-alih aplikasi Anda yang sebenarnya, menerima kode di URL callback yang ditentukan (lokal atau publik tergantung pada pengaturan Anda).

Permintaan Token (Tidak Perlu Pengalihan)

Karena Postman menyadap kode, ia tidak perlu mengarahkan pengguna ke aplikasi terpisah. Ia langsung menggunakan kode ini untuk membuat permintaan ke server otorisasi untuk token akses akhir, yang digunakan untuk berinteraksi dengan API.

Manfaat Menggunakan URL Callback di Postman

• Kenyamanan: Postman menangani seluruh alur otorisasi secara internal, menghilangkan kebutuhan akan pengalihan yang kompleks dan interaksi pengguna di luar Postman.
• Efisiensi: Proses menjadi lebih cepat dan lebih efisien, memungkinkan Anda untuk dengan cepat mendapatkan token akses untuk menguji panggilan API.
• Fleksibilitas Pengujian: Anda dapat dengan mudah menguji skenario otorisasi yang berbeda dengan memodifikasi URL callback atau menggunakan penyedia OAuth yang berbeda di dalam Postman.

Cara Menyiapkan URL Callback di Postman untuk Otorisasi OAuth 2.0?

Langkah 1 - Mengakses Pengaturan Otorisasi

Setelah Anda membuka Postman, navigasikan ke koleksi atau permintaan yang Anda inginkan, dan klik tab Otorisasi.

Langkah 2 - Pilih Jenis Auth ke OAuth 2.0

Selanjutnya, tekan kotak Jenis Auth, dan pilih OAuth 2.0. Ini akan mengubah kolom kanan, memberi Anda lebih banyak bidang untuk dimodifikasi.

Langkah 3 - Tentukan URL Callback

Gulir ke bawah hingga Anda menemukan bagian URL Callback, seperti yang ditunjukkan pada gambar di atas. Di sini, pastikan untuk menyertakan URL callback Anda. Anda memiliki dua opsi untuk URL callback:

Pilihan 1 - Menggunakan URL Lokal Postman (Untuk Pengujian)

Jika Anda hanya menguji di dalam Postman, opsi yang nyaman adalah menggunakan URL lokal yang disediakan oleh Postman. URL ini biasanya dimulai dengan https://app.getpostman.com/oauth2/callback.

Pendekatan ini menjaga semuanya di dalam Postman, menyederhanakan proses pengujian.

Pilihan 2 - Menggunakan URL Publik Aplikasi Anda (Untuk Pengujian Mirip Produksi)

Jika Anda ingin mensimulasikan skenario yang lebih realistis, Anda dapat mengonfigurasi URL callback publik aplikasi Anda yang sebenarnya. Namun, URL ini perlu didaftarkan dengan server otorisasi yang Anda gunakan (misalnya, Google, Facebook).

Langkah 4 - Simpan Perubahan pada API Anda

Terakhir, setelah semua perubahan telah dilakukan, pastikan untuk menyimpannya.

Apidog - Merampingkan Pengembangan API dalam Lingkungan yang Bersih dan Ramping

Pengembang, apakah Anda mencari perubahan pemandangan untuk pengembangan API Anda? Nah, jangan mencari lagi - memperkenalkan kepada Anda Apidog, alternatif Postman yang ampuh yang melengkapi Anda dengan alat lengkap untuk seluruh siklus hidup API.

Memilih Autentikasi OAuth 2.0 untuk API Anda Menggunakan Apidog

Di Apidog, Anda dapat dengan mudah melakukan hal yang sama, kecuali dengan antarmuka pengguna yang lebih sederhana namun elegan.

Navigasikan jalan Anda ke API atau permintaan yang ingin Anda modifikasi, dan pilih header Auth. Jenis Auth default yang dipilih adalah Inherit from Parent, jadi pilih OAuth 2.0.

Menentukan URL Callback di Apidog

Setelah jenis autentikasi OAuth 2.0 dipilih, Anda dapat menggulir ke bawah dan menentukan detail lainnya. Di antara detail ini adalah URL callback. Anda bebas menentukan URL apa pun yang Anda inginkan di sini, seperti yang ditunjukkan pada gambar di atas.

Impor API ke Apidog untuk Modifikasi

Ambil langkah pertama Anda untuk menyempurnakan API Anda dengan mengimpornya ke Apidog. Apidog mendukung berbagai jenis file API, termasuk OpenAPI (atau Swagger), Postman, dan Insomnia.

Pertama, buka bagian Pengaturan di proyek Anda, dan temukan tombol Import Data yang ditemukan di bawah Manajemen Data. Jika Anda tidak dapat menemukan jenis file yang ingin Anda impor, jangan khawatir! Cukup seret dan lepas file ke bagian bawah layar.

Menambahkan Skrip Pengujian di Apidog

Setelah Anda selesai mengimpor API Anda atau membuat proyek baru di Apidog, Anda dapat melanjutkan dengan menambahkan skrip pengujian.

Di bawah bagian Edit API Anda, temukan judul Pre Processors. Anda akan menemukan bilah yang diberi label Custom Script. Di sinilah Anda dapat menerapkan skrip khusus untuk permintaan API Anda. Jika Anda kesulitan mencari tahu apa yang harus ditulis, Anda juga dapat memilih opsi Cuplikan Kode yang ditemukan di sebelah kanan ruang kode.

Kesimpulan

URL Callback Postman memainkan peran penting dalam merampingkan alur kerja otorisasi OAuth 2.0 dalam proses pengembangan dan pengujian. Dengan menentukan URL callback, Anda menghilangkan kebutuhan akan pengalihan yang kompleks dan interaksi aplikasi eksternal. Postman dengan mulus menyadap kode otorisasi dan mengambil token akses, memungkinkan Anda untuk fokus pada pengujian panggilan API dengan efisiensi yang lebih besar.

Fungsionalitas ini, bersama dengan antarmuka Postman yang ramah pengguna secara keseluruhan, menjadikannya alat yang ampuh bagi pengembang yang bekerja dengan API yang menggunakan OAuth 2.0 untuk kontrol akses yang aman.