Brick API Documentation
Brick

Struktur Respons API

Respons Brick API menggunakan struktur yang konsisten sehingga integrasi Anda dapat memisahkan data yang berhasil, pesan pemrosesan asinkron, metadata, dan kesalahan. Gunakan panduan ini untuk memahami cara mengurai respons sinkron dan asinkron, memetakan nilai job_id jika disediakan, dan memutuskan kapan harus mengandalkan callback atau titik akhir status untuk hasil akhir transaksi.

Respon Sukses

Sample of Sync Response

JSONCode
{ "status": 202, data:{ "message": "We are processing your request and will send the data in the callback URL." “job_id”:”XXXX-XXXX-XXXX-XXXX” }, metadata:{ "source": {{API/Widget/Dashboard/SDK/Portal}}, "entity": {{Data/Insight/Verification/Payment}} }, error: null, }

Field description

BidangDeskripsi
statusKode status HTTP/HTTPS
pesanPesan teks
job_idTransaksi unik_id, Ini akan membantu memetakan respons Async
sumberIni menentukan dari mana permintaan APIs datang, Ini bisa berupa salah satu dari API, Widget, Dashabord, SDK atau Portal.
entitasIni menentukan dari produk mana permintaan APIs berasal, Bisa dari Data, Insight, Verifikasi, atau Pembayaran.
kesalahanJika berhasil, kesalahan akan menjadi nol

Sample of Async Response

JSONCode
{ "status": 200, "data": { "message": “We are successfully able to fetch data”, "example-1":"XXXX-XXXX-XXXX", "count":{{Number of objects}}, "example-2"{[ "array1":1, "example-3":"xx-xx-xx" ],[ "array2":1, "example-4":"xx-xx-xx" ]} }, metadata:{ "source": {{API/Widget/Dashboard/SDK/Portal}}, "entity": {{Data/Insight/Verification/Payment}} }, error: null }

Field description

BidangDeskripsi
statusKode status HTTP/HTTPS
pesanPesan teks
dataData respons
sumberIni menentukan dari mana permintaan APIs datang, Ini bisa berupa salah satu dari API, Widget, Dashabord, SDK atau Portal.
entitasIni menentukan dari produk mana permintaan APIs berasal, Bisa dari Data, Insight, Verifikasi, atau Pembayaran.
kesalahanJika berhasil, kesalahan akan menjadi nol

Respon Kesalahan

Sample of error response

JSONCode
{ "status" : XXX, “error”:{ "code": {{brick_unique_error_code}}, "message": {{description_of_error}}, "action": {{further_action}}, "reason": {{Actual_reason_for_error}} }, “metadata”:{ "source": {{API/Widget/Dashboard/SDK/Portal}}, "entity": {{Auth/Insight/Verification/Payment}} }, data:null }

Field description

BidangDeskripsi
statusKode status HTTP/HTTPS
kodeBrick kode status yang disesuaikan
pesanPesan teks
tindakanTindakan lebih lanjut untuk mencegah kesalahan ini
sumberIni menentukan dari mana permintaan APIs datang, Ini bisa berupa salah satu dari API, Widget, Dashabord, SDK atau Portal.
entitasIni menentukan dari produk mana permintaan APIs berasal, Bisa dari Data, Insight, Verifikasi, atau Pembayaran.
kesalahanJika berhasil, kesalahan akan menjadi nol

Anda dapat merujuk semua kemungkinan kode kesalahan di error handling section.


Last modified on