10 Hal yang perlu ada sebelum merancang API B2B

API, atau Application Programming Interface, adalah sebuah konsep dalam pengembangan perangkat lunak yang memungkinkan aplikasi untuk berkomunikasi dengan aplikasi lainnya. API bertindak sebagai jembatan yang memfasilitasi pertukaran data dan fungsi antara dua sistem terpisah, memungkinkan mereka untuk berinteraksi dan berfungsi bersama-sama secara harmonis. Dalam konteks web, API sering digunakan untuk memungkinkan aplikasi web untuk mengirim dan menerima data dari server tanpa perlu memuat ulang halaman web.

Dalam kenyataannya, proses pembuatan API mutlak membutuhkan komunikasi dua belah pihak pengembang. Hal ini dikarenakan API membutuhkan kesamaan persepsi antara pengembang yang dibaca datanya dan pengembang yang mengakses datanya. Berita baiknya JSON, dan REST API sudah menjadi dua standar defacto yang digunakan untuk bertukar pesan API, sehingga bahasa komunikasi sudah tidak menjadi kendala lagi, yang menjadi kendala adalah kesamaan persepsi spesifikasi yang akan digunakan untuk komunikasi. Berdasar pada kendala tersebut berikut adalah 10 hal yang perlu ada sebelum merancang API B2B

1. Tujuan API. APi memiliki tujuan sebagai contoh API membaca transaksi dari sistem A untuk membangkitkan tagihan keluaran di sistem B
2.  Definisi data. Definisi data berisi data yang akan dipertukarkan antara A dan B. Misalkan ID transaksi berupa GUID, nama berpanjang maksimal 120 karakter, dan sebagainya
3.  Keamanan API.  Berisi mengenai pembahasan bagaimana keamanan dilakukan seperti model akses berbasis sertifikat, pengguna, kunci rahasia, atau yang lain
4. Alamat pemanggilan API. Berisi alamat API dan instruksinya misalnya GET /v2/reporting
5. Query parameter. Parameter input yang berperan sebagai masukan misalnya start_date string dengan format dd-mm-yyyy dan opsional bisa kosong
6. Perilaku API. Berisi perilaku dan proses API dalam memproses misalnya jika parameter input kosong maka ambil transaksi hari ini.
7.  Response. Berupa format JSON keluaran API 
8. Pola konsumsi API. Bagaimana API dipanggil oleh sistem apakah diambil satu record atau bulk dengan batch.
9. Eksternal sistem. Berisi sistem-sistem yang akan mengakses API tersebut dapat berupa web, mobile, atau yang lain beserta model aksesnya misalnya akses menggunakan VPN, lokal, atau melalui load balancer
10. Catatan tambahan. Berisi informasi teknis seperti contoh dalam bahasa pemrograman, keterbatasan API yang terjadi, dan sebagainya.

Demikian sepuluh hal yang perlu kita siapkan sebelum merancang API B2B, dokumentasi yang benar akan menyelaraskan dan memudahkan kita melakukan sinkronisasi.