Persiapkan Diri Anda untuk Menggunakan API
1. Buat Akun Brick
Untuk mulai menggunakan APIs Brick, Anda harus membuat akun. Jika Anda belum mendaftar, silakan daftar di sini https://app.onebrick.io/signup
2. Dapatkan Kredensial API Klien Anda
Navigasikan ke bagian 'Konfigurasi' dan periksa di bawah tab 'Kredensial API'. Anda akan menemukan Client ID dan Client Secret Anda di sana.
3. Konfigurasikan URL Panggilan Balik
API v2 Brick menggunakan mekanisme panggilan balik untuk memberi tahu aplikasi Anda tentang berbagai peristiwa. Penting untuk menyiapkan URL panggilan balik yang sesuai untuk setiap API yang ingin Anda gunakan.
Langkah-langkah untuk Mengatur URL Panggilan Balik:
- Arahkan ke bagian 'Konfigurasi'.
- Buka tab 'URL Panggilan Balik'.
- Masukkan URL panggilan balik yang sesuai untuk setiap layanan API yang ingin Anda integrasikan.
- Gunakan Test URL atau Save & Test untuk mengonfirmasi bahwa Brick dapat mengirim permintaan panggilan balik dan menerima respons yang diharapkan dari server Anda.
Tabel Konfigurasi URL Panggilan Balik
| Layanan API | Nama Bidang URL Panggilan Balik |
|---|---|
| Pencairan Pembayaran APIs | URL Panggilan Balik Pencairan |
| Akun Virtual APIs | URL Panggilan Balik Akun Virtual |
| QRIS APIs | URL Panggilan Balik QRIS |
| Dompet elektronik APIs | URL Panggilan Balik dompet elektronik |
Catatan: Setiap layanan API memerlukan URL panggilan baliknya sendiri yang berbeda. Pastikan titik akhir yang Anda berikan dikonfigurasi dengan benar untuk menangani permintaan POST masuk dari server Brick dan mengembalikan respons yang diharapkan.
Respons yang Diharapkan Dari Penerima Panggilan Balik Anda
Untuk panggilan balik transaksi normal, kembalikan HTTP 200 hanya setelah sistem Anda menerima dan menyimpan peristiwa panggilan balik. Jika penerima Anda mengembalikan respons non-200, waktu habis, atau tidak dapat dijangkau, Brick mungkin menganggap panggilan balik tersebut gagal dan mencoba lagi sesuai dengan kebijakan coba ulang panggilan balik.
Saat Anda menguji atau menyimpan URL Panggilan Balik dari dasbor, Brick mengirimkan panggilan balik validasi terlebih dahulu. Pengujian dasbor hanya berhasil bila penerima Anda mengembalikan HTTP 200 dengan JSON ACK yang mengulangi pengujian persis referenceId yang dikirim oleh Brick:
Code
Anda juga dapat mengembalikan nilai yang sama seperti reference_id. Nilainya harus cocok dengan referenceId di payload pengujian panggilan balik atau header X-Brick-Test-Reference. HTTP 200 dengan isi kosong, teks biasa, JSON tidak valid, referensi hilang, atau referensi berbeda dianggap sebagai pengujian panggilan balik yang gagal.
Tindakan penyiapan panggilan balik dan pengiriman ulang terus menggunakan rute penulisan dasbor yang ada untuk kompatibilitas mundur. Pemeriksaan status panggilan balik bersifat baca-saja dan diekspos melalui rute baca dasbor v3 GET /v3/exp/dashboard/disbursement/callback/status bila dilihat dari Dasbor Klien.
Lingkungan API
Brick menyediakan dua lingkungan terpisah untuk mendukung kasus penggunaan pengembangan dan produksi.
Untuk membuat dan mengelola kredensial API Anda untuk setiap lingkungan, masuk ke Brick Dashboard, navigasikan ke menu Configuration, dan pilih tab API Credentials.
Lingkungan yang Tersedia
| Lingkungan Hidup | URL dasar | Tujuan |
|---|---|---|
| kotak pasir | https://sandbox.onebrick.io/v2 | Gunakan lingkungan ini untuk pengujian dan pengembangan. Ini mensimulasikan perilaku langsung menggunakan data tiruan. |
| Produksi | https://api.onebrick.io/v2 | Gunakan lingkungan ini untuk aplikasi langsung yang terhubung ke lembaga keuangan nyata. |
🚧 Catatan Penting
- Kredensial berbeda untuk setiap lingkungan. Pastikan Anda menggunakan client_key dan client_secret yang benar untuk lingkungan tempat Anda bekerja.
- Transaksi di lingkungan Sandbox tidak memengaruhi akun atau institusi nyata.
- Sebelum beralih ke Produksi, pastikan integrasi Anda telah diuji sepenuhnya di Sandbox.