Untuk mengintegrasikan sistem aplikasi atau toko online Anda secara otomatis dengan layanan Biteship, Anda dapat menggunakan fitur Webhook.
Fitur ini memungkinkan sistem Anda menerima notifikasi secara real-time mengenai perubahan status pengiriman tanpa harus melakukan pengecekan manual secara terus-menerus ke API Biteship.
Artikel ini akan membantu Anda memahami:
- Apa itu Webhook Biteship
- Manfaat menggunakan Webhook untuk operasional
- Cara kerja Webhook (Event Notification)
- Langkah-langkah melakukan konfigurasi
- Keamanan dan verifikasi Webhook
- Tips penanganan data (Error handling)
1. Apa Itu Webhook Biteship?
Webhook adalah sebuah mekanisme yang digunakan oleh Biteship untuk mengirimkan data atau informasi secara otomatis ke server/aplikasi Anda segera setelah sebuah peristiwa (event) terjadi.
Jika API biasa mengharuskan Anda "bertanya" (pull data), Webhook bekerja dengan cara "memberi tahu" (push data). Contohnya, saat paket kurir berubah status menjadi "Selesai", Biteship akan langsung mengirimkan data status tersebut ke URL yang Anda tentukan.
2. Manfaat Menggunakan Webhook
Dengan mengaktifkan Webhook, bisnis Anda akan mendapatkan efisiensi sebagai berikut:
- Update Real-Time: Status pesanan di aplikasi Anda berubah otomatis saat kurir memperbarui status di lapangan.
- Efisiensi Resource: Anda tidak perlu melakukan polling API berulang kali yang dapat membebani server.
- Otomatisasi Lanjutan: Anda bisa memicu aksi otomatis lainnya, seperti mengirimkan email/WhatsApp notifikasi ke pembeli saat paket tiba.
- Sinkronisasi Data: Memastikan data antara dashboard Biteship dan database internal Anda selalu selaras.
3. Event yang Didukung oleh Webhook Biteship
Biteship menyediakan notifikasi untuk berbagai peristiwa penting dalam siklus pengiriman, di antaranya:
- order.status_update: Dikirimkan setiap kali ada perubahan status pengiriman (misal: Pickup, Transit, Delivered).
- order.waybill_update: Dikirimkan saat nomor resi resmi dari kurir telah diterbitkan.
- order.cancelled: Dikirimkan jika pesanan dibatalkan oleh sistem atau kurir.
4. Cara Melakukan Konfigurasi Webhook
Langkah 1: Siapkan URL Endpoint
Siapkan sebuah URL pada server Anda yang siap menerima data dalam format JSON via metode POST.
Langkah 2: Login ke Dashboard Biteship
Masuk ke akun Biteship Anda dan navigasikan ke menu Settings Developers Webhooks.
Langkah 3: Tambahkan Webhook URL
Klik tombol tambah Webhook, masukkan URL endpoint Anda, dan pilih jenis event yang ingin Anda pantau.
Langkah 4: Lakukan Uji Coba (Test)
Gunakan fitur "Test Webhook" untuk memastikan server Anda dapat menerima payload data dari Biteship dengan sukses (HTTP Status 200).
5. Keamanan Webhook
Untuk memastikan data yang masuk ke server Anda benar-benar berasal dari Biteship, kami menyarankan:
- Webhook Secret: Gunakan kunci rahasia (Secret Key) yang disediakan untuk memvalidasi tanda tangan (signature) pada setiap request.
- HTTPS: Pastikan endpoint URL Anda menggunakan protokol aman (HTTPS).
- IP Whitelisting: Jika diperlukan, batasi akses ke server Anda hanya dari alamat IP resmi milik Biteship.
6. Tips Penanganan (Best Practices)
- Respon Cepat: Pastikan server Anda segera memberikan respon HTTP 200 OK setelah menerima data sebelum melakukan proses logis yang berat.
- Antrean (Queue): Gunakan sistem antrean jika Anda perlu melakukan pemrosesan data yang lama agar koneksi tidak timeout.
- Idempotency: Pastikan sistem Anda dapat menangani jika sewaktu-waktu Webhook mengirimkan data yang sama lebih dari satu kali.
7. FAQ Tentang Webhook
Bagaimana jika server saya sedang down?
Biteship biasanya akan mencoba mengirimkan ulang (retry) notifikasi secara berkala dalam jangka waktu tertentu hingga server Anda memberikan respon sukses.
Apakah satu akun bisa memiliki lebih dari satu URL Webhook?
Ya, Anda dapat menambahkan beberapa URL Webhook untuk kebutuhan lingkungan pengembangan (Staging) dan produksi (Production).
8. Kesimpulan
Webhook adalah solusi terbaik bagi bisnis yang ingin memberikan pengalaman pelanggan yang responsif melalui pembaruan status pengiriman otomatis.
Jika Anda membutuhkan bantuan teknis mengenai integrasi Webhook, silakan merujuk pada Dokumentasi API Biteship atau hubungi tim IT support kami melalui support@biteship.com.