API Documentation

Kredibel API dapat dimanfaatkan oleh para pemilik usaha startup untuk mengelola data blacklistnya sendiri ataupun menarik seluruh data blacklist yang dimiliki oleh pihak Kredibel dan bersifat sharing data. API ini terbagi menjadi dua jenis, yaitu API nomor rekening dan API nomor telepon.


API Checking Rekening


Fungsi API Checking Rekening Kredibel

  • Menarik / membaca rekening blacklist yang telah anda input
  • Menarik / membaca rekening blacklist yang dimiliki Kredibel yang bersifat sharing data
  • Menarik / membaca rekening whitelist yang telah anda input
  • Menarik / membaca rekening whitelist yang dimiliki Kredibel yang bersifat sharing data

Access Token & API Key Input Rekening

Segala izin akses API rekening Kredibel diberikan secara tertutup kepada pihak perusahaan, startup, pemilik bisnis lain, lembaga pemerintah, lembaga non pemerintah, lembaga lainnya, ataupun pihak lainnya yang tidak tercantum dalam statement ini setelah melakukan kesepakatan yang didasari oleh hukum yang berlaku. Apabila anda tertarik untuk menggunakan API ini, silahkan menghubungi kami melalui laman berikut: Hubungi Kami. Untuk ketentuan secara umum dapat dibaca di laman Kebijakan Layanan kami.

Cara Penggunaan API Checking Rekening Kredibel

Secara umum struktur API rekening Kredibel dapat diakses melalui URL dengan struktur umum berikut

http://www.kredibel.co.id/dev/api_checking?apiKey={apiKey}&acc_number={Account_Number}
  • {APIKEY} merupakan key khusus yang diberikan untuk mengakses API Rekening Kredibel. API Key ini merupakan hasil enskripsi gabungan antara MD5 dan SHA-1.
  • {ACCOUNT_NUMBER} merupakan input nomor rekening pengguna. Semua input akan otomatis berubah menjadi angka dalam sistem. Input 199-129 akan menghasilkan 199129.

Respon API Rekening Kredibel

Seluruh output yang dihasilkan dari request API ini akan menghasilkan output dalam bentuk JSON. Dengan berikut struktur umum respon API

{
    "success": "true",
    "message": "{status server}",
    "data": {
        "blacklist": "{true or false}",
        "nomor": "{account_number}",
        "link": "{link}"
    }
}
  • {status server} merupakan informasi mengenai koneksi API pada server Kredibel. Secara default berisikan 200 OK.
  • {true or false} merupakan informasi mengenai nomor rekening tersebut terblacklist atau tidak. True akan muncul ketika nomor tersebut sudah terblacklist di database kredibel
  • {account_number} merupakan nomor rekening yang dicek.
  • {link} merupakan link/URL yang mengarahkan kepada hasil pengecekan via web

Namun dalam beberapa kasus ketika API gagal di akses / kesalahan format parameter URL, json yang dihasilkan akan menunjukan output yang berbeda. Berikut json default ketika terjadi kesalahan parameter / API gagal menjalankan prosesnya

{
    "response": "{status server}",
    "status": "{success or failed}",
    "error_code": "{error_code}",
    "message": "{message}"
}
  • {status server} merupakan informasi mengenai koneksi API pada server Kredibel. Secara default berisikan 200 OK.
  • {success or failed} merupakan informasi mengenai koneksi/akses API berhasil atau tidak. {success} akan muncul ketika anda benar benar berhasil melakukan seluruh proses keterkaitan pada API kredibel.
  • {error_code} merupakan kode error yang dapat membantu anda menentukan error ketika melakukan koneksi dengan API Kredibel. Error code ini dapat dilihat keterangannya di Tabel Keterangan Error Code.
  • {message} merupakan pesan error yang memudahkan anda untuk men-debug koneksi terhadap API

Tabel dan Catatan Lain


TABEL KETERANGAN ERROR CODE

NO ERROR CODE KETERANGAN
1. KRE_01 Menandakan bahwa seluruh proses terkait API Kredibel telah sukses dilakukan. Tidak ada satu error pun yang terdeteksi oleh sistem.
2. KRE_02 Menandakan bahwa anda belum menuliskan APIKEY pada parameter URL
3. KRE_03 Menandakan bahwa APIKEY yang anda tuliskan pada parameter URL tidak berlaku/belum terdaftar/salah
4. KRE_04 Menandakan parameter masih ada yang kosong
5. KRE_05 Menandakan bahwa API gagal melakukan checking
6. KRE_06 Menandakan bahwa ada parameter yang kurang
7. KRE_07 Menandakan bahwa nomor rekening/id bank yang anda letakan di parameter URL adalah karakter lain selain angka
8. KRE_08 Menandakan bahwa kode bank tidak kami miliki/belum terdaftar dalam Tabel Kode Bank