Kepada seluruh pengguna API Jurnal,
Kami ingin memberikan pemberitahuan penting terkait perubahan pada Dokumentasi API Jurnal yang akan berdampak pada beberapa endpoint transaksi. Perubahan ini bertujuan untuk meningkatkan kualitas dan keandalan layanan kami, serta memastikan bahwa API dapat mendukung skala data yang lebih besar di masa mendatang.
Ringkasan Perubahan
Kami akan melakukan perubahan tipe data untuk semua Primary Key (ID) di berbagai endpoint transaksi. Saat ini, tipe data untuk ID memiliki rentang nilai yang terbatas, namun akan diperluas untuk mendukung nilai-nilai yang jauh lebih besar. Perubahan ini berlaku untuk semua field dengan format `*_id` (contoh: `selected_po_id`, `sell_tax_id`, dll.).
Mengapa Rentang Nilai Terbatas Menjadi Masalah?
Saat ini, tipe data yang digunakan untuk ID memiliki batasan maksimum dan minimum tertentu. Artinya, ada batas jumlah unik ID yang dapat ditampung oleh sistem. Sebagai contoh:
- Sistem saat ini hanya mampu menangani sekitar 2 miliar nilai unik untuk bilangan positif.
- Jika jumlah transaksi atau data melebihi angka tersebut, sistem tidak akan mampu menghasilkan ID baru secara akurat, yang dapat menyebabkan kesalahan data atau bahkan kegagalan sistem.
Untuk mengantisipasi pertumbuhan data di masa depan, kami memutuskan untuk memperluas rentang nilai yang dapat ditampung oleh ID. Dengan perubahan ini, sistem akan dapat menangani jumlah data yang jauh lebih besar tanpa kendala.
Langkah yang Harus Diambil
Untuk memastikan kelancaran integrasi setelah perubahan ini, silakan lakukan hal berikut:
1. Tinjau Ulang Kode Aplikasi: Pastikan bahwa semua pengecekan tipe data untuk field `id` telah diperbarui agar dapat menangani rentang nilai yang lebih besar.
2. Uji Integrasi dengan API: Lakukan pengujian terhadap integrasi dengan API menggunakan dokumentasi terbaru untuk memastikan semuanya berfungsi dengan baik.
3. Hubungi Tim Dukungan Jika Diperlukan: Jika Anda mengalami kesulitan atau memiliki pertanyaan, jangan ragu untuk menghubungi tim dukungan kami.
Dokumentasi API publik juga perlu diperbarui untuk mengubah tipe data model. Endpoint yang terdampak adalah:
-
/public/jurnal/api/v1/purchase_returns
- /public/jurnal/api/v1/sales_returns
- /public/jurnal/api/v1/sales_invoices
- /public/jurnal/api/v1/purchase_invoices
- /public/jurnal/api/v1/expenses
- /public/jurnal/api/v1/bank_withdrawals
- /public/jurnal/api/v1/bank_transfers
- /public/jurnal/api/v1/receive_payments
- /public/jurnal/api/v1/sales_orders
- /public/jurnal/api/v1/bank_deposits
- /public/jurnal/api/v1/purchase_payments
- /public/jurnal/api/v1/purchase_orders
- /public/jurnal/api/v1/purchase_deliveries
- /public/jurnal/api/v1/purchase_order_payments
- /public/jurnal/api/v1/purchase_quotes
- /public/jurnal/api/v1/sales_quotes
- /public/jurnal/api/v1/sales_deliveries
- /public/jurnal/api/v1/sales_order_payments
- /public/jurnal/api/v1/sales_lists
- /public/jurnal/api/v1/sales_by_customers/export
- /public/jurnal/api/v1/sales_by_products
- /public/jurnal/api/v1/vendor_credit_memo_refund
- /public/jurnal/api/v1/customer_apply_credit_memo
- /public/jurnal/api/v1/vendor_apply_credit_memo
- /public/jurnal/api/v1/customer_credit_memo_refund
- /public/jurnal/api/v1/credit_memos
- /public/jurnal/api/v1/journal_entries
- /public/jurnal/api/v1/convert_products
- /public/jurnal/api/v1/asset_managements/
- /public/jurnal/api/v1/warehouses/
- /public/jurnal/api/v1/select2_resources/get_transaction
Contoh perubahan yang dapat dilakukan oleh klien:
- Merah = Sebelum
- Hijau = Setelah
API Docs: https://api-jurnal.api-docs.io/
Dampak Jika Tidak Dilakukan Penyesuaian
Jika Anda tidak menyesuaikan kode aplikasi atau sistem Anda untuk mengakomodasi perubahan tipe data ini, maka ada risiko sebagai berikut:
1. Data yang Diterima Akan Salah: Sistem Anda mungkin tidak dapat membaca atau memproses nilai-nilai ID yang lebih besar, sehingga data yang diterima menjadi tidak akurat.
2. Fungsionalitas Aplikasi Tidak Bekerja dengan Baik: Fitur atau fungsi yang bergantung pada ID dari API Jurnal mungkin tidak berfungsi sebagaimana mestinya.
3. Potensi Error atau Crash: Jika sistem Anda tidak mendukung rentang nilai yang lebih besar, ada kemungkinan terjadi error atau crash selama proses integrasi dengan API Jurnal.
Referensi Dokumentasi
Untuk informasi lebih lanjut tentang perubahan ini, silakan merujuk ke:
- API Docs: https://api-jurnal.api-docs.io/
- Swagger: https://jurnal-mekari.stoplight.io/docs/jurnal-api
Kontak Kami
Jika Anda memiliki pertanyaan lebih lanjut terkait perubahan ini, silakan hubungi kami melalui email: halojurnal@mekari.com
Kami sangat menghargai kerja sama Anda dalam memastikan kelancaran proses integrasi dengan API Jurnal. Terima kasih atas perhatian dan kerjasamanya.
Salam hangat,
Tim Jurnal