Account

API resource di BigBox adalah resource terproteksi sehingga diperlukan pencatatan akses dan transaksi guna kepentingan audit trail dan traffic management. Oleh sebab itu untuk dapat menggunakan API di BigBox maka syarat mandatory yang harus dipenuhi adalah memiliki akun di BigBox. Namun untuk sekedar melakukan eksplorasi API dapat dilakukan tanpa harus memiliki akun. Beberapa benefit yang […]

Header

Setiap request API ke BigBox harus comply dengan standar HTTP dengan mandatory header yang harus disertakan dalam setiap API call adalah sebagai berikut:  Dengan kemungkinan response sebagai berikut: 200 – OK 3XX – Redirect 400 – Bad request 401 – Unauthorized to access 403 – Forbidden 404 – Not Found 405 – Method Not Allowed 404 – Request not found 500 – Internal Server Failure 502 – Bad Gateway Error

Authorization

BigBox menggunakan API-Key Authentication sebagai authorization framework. Authorization diberikan dalam bentuk API-Key dimana API-Key diperoleh melalui proses yang di dalamnya menyertakan key dan secret. Pasangan kunci ini diperoleh user pada saat user melakukan registrasi pada website BigBox. Semua request untuk mengakses API di BigBox harus menyertakan parameter Authorization pada HTTP header dengan format X-API-KEY: Value, […]

HTTP REST

REST (Representational State Transfer) adalah seperangkat aturan yang memungkinkan sebuah aplikasi untuk mengakses resources secara terdistribusi. REST dapat mempertukarkan berbagai format penulisan seperti XML maupun JSON dan pada umumnya menggunakan protokol HTTP dalam mekanisme pertukaran datanya. REST bersifat stateless dalam arti bahwa tidak perlu ada koneksi yang harus dijaga selama komunikasi berlangsung antara server dengan client. Proses komunikasi hanya menggunakan session yang hanya terbentuk ketika […]

API Basic Call

Seluruh API yang ada di BigBox dapat diakses dengan menggunakan API- Key. Authentication adalah proses konfirmasi bahwa pengakses memiliki hak akses untuk menggunakan API. Sebelumnya, untuk melakukan verifikasi hak akses, aplikasi menggunakan cookies yang berisi session ID dan tersimpan pada sisi server. Hal ini mengharuskan developer untuk menyediakan media penyimpanan yang bersifat unik untuk masing-masing […]

Overview

API (application programming interface) adalah suatu interface, terdiri dari command, function, dan protocol, yang memungkinkan suatu aplikasi dapat berkomunikasi dengan aplikasi lainnya. API mendefinisikan suatu fungsi yang tersedia di dalamnya, bagaimanan cara menggunakannya, format apa yang harus digunakan, input apa yang harus diberikan, dan output apa yang akan didapat. Gambar di atas memvisualisasikan konsep dari API, di mana API […]