Penerapan Response Code 308 untuk Mendukung Perpindahan Host pada Sistem Integrasi API Accurate Online
Dalam rangka peningkatan stabilitas dan performa layanan, sistem dapat melakukan perubahan host endpoint API Accurate Online. Jika terjadi perpindahan host, maka request ke host yang lama akan menghasilkan response code 308 (Permanent Redirect). Oleh karena itu sebagai bentuk antisipasi dan referensi teknis, diharapkan untuk memberlakukan penanganan khusus pada response code 308 saat melakukan integrasi API dengan Accurate Online.
Dengan menerapkan konfigurasi yang direkomendasikan di bawah ini, integrasi sistem Anda dapat tetap berjalan secara optimal, meskipun terjadi perpindahan host di sisi server.
Penyesuaian konfigurasi Follow Redirect untuk otomatis menangani Response Code 308 (Permanent Redirect)
Agar proses integrasi API Accurate Online tetap berjalan tanpa gangguan meskipun terjadi perpindahan host, perlu dilakukan penyesuaian konfigurasi pada tools yang digunakan (seperti Postman atau aplikasi client lainnya).
Konfigurasi yang Harus Diaktifkan:
1. Automatically Follow Redirects
-
Tujuan
Mengijinkan client untuk secara otomatis mengikuti response redirect (seperti response code 308) yang dikirim server.
-
Penjelasan
Jika host lama sudah berpindah ke host baru, server akan memberikan response code 308 (Permanent Redirect). Jika opsi ini tidak diaktifkan, permintaan Anda tidak akan diteruskan ke host baru dan integrasi akan gagal.
-
Status yang disarankan: ON / TRUE
2. Follow Original HTTP Method (* jika ada)
-
Tujuan
Menjaga metode HTTP asli (misalnya POST, DELETE) saat mengikuti redirect, bukannya mengubahnya menjadi GET.
-
Penjelasan
Secara default, beberapa client akan mengubah metode permintaan menjadi GET saat mengikuti redirect. Ini dapat menyebabkan permintaan tidak valid di endpoint tujuan.
-
Status yang disarankan: ON / TRUE
3. Follow Authorization Header (* jika ada)
-
Tujuan
Memastikan header Authorization (misalnya Bearer {access_token} atau Bearer {api_token}) tetap dikirim saat permintaan dialihkan (redirect) ke host berbeda.
-
Penjelasan
Redirect response code ke host baru berbeda host, dan secara default banyak client tidak menyertakan kembali token saat redirect, sehingga permintaan akan gagal otentikasi.
-
Status yang disarankan: ON / TRUE
Contoh Konfigurasi (Postman / API Testing Tool):
Sebagai contoh, pada aplikasi Postman konfigurasi yang telah disebutkan tersebut dapat diaktifkan lewat langkah berikut:
- Buka tab Settings pad Postman.
- Aktifkan opsi “Automatically follow redirects”.
- Aktifkan opsi “Follow original HTTP Method”.
- Aktifkan opsi “Follow Authorization header”.
Dampak Jika Tidak Mengaktifkan Konfigurasi
Apabila kedua konfigurasi Follow Redirect tidak diaktifkan, maka dapat terjadi beberapa kendala sebagai berikut:
- Sistem akan menerima respon 308 (Permanent Redirect), namun tidak melakukan redirect otomatis.
- Jika redirect terjadi ke host berbeda, namun header token otorisasi tidak diikutsertakan, server akan menolak permintaan (karena dianggap tidak memiliki otorisasi).
- API yang gagal karena perbedaan host ini akan mendapatkan response tidak wajar 308 Permanent Redirect atau 401 Unauthorized.
Contoh Kendala Response (Error 308 – Host Tidak Sesuai)
Jika Anda tidak mengaktifkan Follow Redirect maka request ke host yang tidak sesuai akan menghasilkan hasil seperti contoh dibawah ini saat melakukan permintaan API, hal itu menandakan bahwa database tidak tersedia pada host yang Anda gunakan dan Anda harus segera mengganti host ke yang baru:
Pada contoh permintaan API di atas, permintaan API awal dilakukan ke host lama yaitu https://public.accurate.id. Namun, sistem Accurate Online merespon bahwa database yang dimaksud tidak tersedia pada host tersebut dan hanya tersedia di host baru yaitu https://zeus.accurate.id.
Oleh karena itu, Anda wajib mengganti konfigurasi URL host API Anda ke host yang baru seperti https://zeus.accurate.id untuk menghindari kegagalan integrasi akibat host yang tidak sesuai.
Penyesuaian sistem terintegrasi saat terjadi perubahan Host
Meskipun konfigurasi follow redirect di atas memungkinkan sistem untuk tetap berjalan, penggunaannya pada response code 308 hanya bersifat untuk memfasilitasi transisi perpindahan host. Anda tetap diwajibkan untuk mengganti URL host yang digunakan dalam sistem Anda untuk mengirimkan request API dengan host baru yang ditentukan oleh response atau informasi resmi dari Accurate Online.
Penggantian ini bertujuan untuk:
- Menjaga performa dan kestabilan integrasi jangka panjang.
- Menghindari ketergantungan pada mekanisme redirect.
- Mencegah kemungkinan kegagalan otorisasi yang mungkin terjadi akibat redirect antar host.
- Menghindari penggunaan host obsolete yang tidak akan mengembalikan response apapun
Rekomendasi pemeriksaan host baru
Untuk mendapatkan nilai host yang terbaru, Anda dapat mendapatkan pada body response 308 pada JSON “endpoint” seperti pada contoh sebelumnya.
Jika Anda telah menyalakan Follow Redirect dan tidak lagi memungkinkan secara teknis untuk menyisipkan proses tambahan pada proses redirect, maka direkomendasikan untuk melakukan pengecekan berkala lewat penggunaan API https://account.accurate.id/api/open-db.do jika menggunakan jenis otorisasi OAuth, atau jika menggunakan otorisasi API Token lewat penggunaan API https://account.accurate.id/api//api-token.do minimal setiap 30 hari sekali.