API Reseller
    API Reseller
    • Pengantar
    • Balance (Saldo)
      • Mengecek Saldo
        GET
    • Produk
      • Rangkuman
      • Daftar Produk
        GET
      • Detail Produk
        GET
    • Pesanan
      • Membuat Pesanan
        POST
      • Detail Pesanan
        GET
      • Notifikasi Pesanan
        POST

    Pengantar

    Hai, Selamat Datang! Reseller Topupgim.
    API Reseller dikembangkan berdasarkan konsep REST API yang menggunakan kode respons HTTP untuk mendeteksi jika terjadi kesalahan. Kami menggunakan fitur dan fungsi bawaan HTTP sehingga dapat dimengerti oleh klien HTTP umum. Respons API kami memiliki format JSON, termasuk juga pesan kesalahannya.
    Untuk menggunakan API Reseller ini sebelumnya kamu harus sudah memiliki akun Topupgim yang sudah diupgrade ke Agen.
    Berikut langkah-langkahnya:
    1.
    Sudah mendaftarkan akun Topupgim. Jika belum, silahkan mendaftar di Pendaftaran Akun.
    2.
    Masuk ke halaman Pendaftaran Agen kemudian lengkapi data yang diminta.
    3.
    Setelah disetujui, buat PIN transaksi pada halaman Akun Saya > Kata Sandi / PIN.
    4.
    Mengisi saldo voucher yang akan digunakan untuk pembelian produk.
    5.
    Mengajukan permintaan aktivasi akses API Reseller ke kontak Admin Topupgim.
    6.
    Setelah diaktivasi, kamu akan mendapatkan Client ID dan Secret Key yang dapat kamu temukan di pengaturan api.
    7.
    Siapkan url notifikasi dan alamat ip server yang kamu gunakan untuk mengakses api kemudian simpan di pengaturan api.

    Base URL#

    ModeBase URL
    Productionhttps://api.topupgim.com

    Otentikasi#

    Setiap requests wajib menggunakan ip yang sudah di-whitelist sebelumnya dan menggunakan otentikasi data headers berikut:
    HeaderDeskripsi
    x-client-idClient ID tetap yang didapatkan di halaman pengaturan api.
    x-secret-keySecret Key dapat diubah melalui halaman pengaturan api.

    Notifikasi (Webhook)#

    Umumnya notifikasi pesanan akan dikirim melalui requests POST ke url notifikasi yang sudah kamu setel sebelumnya pada halaman pengaturan api.
    Untuk menjaga keaslian webhook dari Topupgim, kamu dapat memvalidasinya melalui:
    headers x-signature dengan format md5("clientID:secretKey:referenceID").

    Respon API#

    Setiap respons API berupa format JSON yang memiliki struktur sebagai berikut:
    HTTP StatusResponse MessageDeskripsi
    200OKPermintaan berhasil dan memenuhi spesifikasi yang diminta.
    403IP_RESTRICTEDAkses ditolak, ip address harus di-whitelist terlebih dahulu.
    401UNAUTHORIZEDOtentikasi gagal, pastikan client id dan secret key sudah benar.
    400BAD_REQUESTTerdapat tipe bidang requests yang tidak memenuhi spesifikasi.
    422REQUEST_NOT_PROCESSABLETerdapat tipe bidang requests yang tidak memenuhi spesifikasi.
    404NOT_FOUNDHalaman atau data yang dicari tidak ditemukan.
    404SKU_NOT_AVAILABLEKode sku tidak ditemukan atau sedang tidak aktif saat membuat pesanan.
    500INSUFFICIENT_BALANCESaldo tidak mencukupi terhadap harga produk saat membuat pesanan.
    500INVALID_PRICEHarga produk melebihi max_price yang disetel saat membuat pesanan.
    500INTERNAL_ERRORTerjadi keslalahan pada sisi server kami.
    Modified at 2023-12-21 06:54:01
    Next
    Balance (Saldo)
    Built with