API Method

Setelah anda berhasil login maka akan muncul tampilan landing page seperti gambar dibawah ini

• Klik 1 . Untuk Akses Metadata

• Klik 2. Untuk Akses Tinjauan

• Klik 3. Untuk Akses Repositori

[API Method Given Permission]

POST https://wsbp.bpbatam.go.id/mantra/[json|api|xml]/bpbatam/[method given]

untuk method yang diinginkan sesuai dengan method yg diberikan, URL bisa dilihat di menu Metadata keterangan pilihan json|api|xml merupakan pilihan format response yang diinginkan

Headers

Name	Type	Description
AccessKey	string	diberikan sesuai dengan accessKey yang digenerate by sistem bisa dilihat di menu Metadata atau Tinjauan
Content-Type	string	berdasarkan format body yang akan dilemparkan application/json atau application/x-www-form-urlencoded
User-Agent	string	MANTRA

Request Body

Name	Type	Description
[sesuai method]	string	berdasarkan parameter yang diberikan di menu Metadata dan Tinjauan. Untuk contoh parameter yang berupa json ada di keterangan pada menu Metadata untuk elemen data nya untuk tipe data parameter semua berupa string

200

Contoh JSON

{
    "response": {
        "status": 1,
        "code": 200,
        "message": "Sukses",
        "data": "",
        "datapath": "http:\/\/wsbp.bpbatam.go.id\/mantra\/json\/bpbatam\/...\/...",
        "datatype": "text",
        "dataperiode": "...-...-... ...:...:...",
        "datasource": "url",
        "onlinecode": 200,
        "onlinemessage": "Sukses"
    }
}

Contoh XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>1</status>
    <code>200</code>
    <message>Sukses</message>
    <data>
        ...
    </data>
    <datapath>https://wsbp.bpbatam.go.id/mantra/xml/bpbatam/...</datapath>
    <datatype>text</datatype>
    <dataperiode>...-...-... ...:...:...</dataperiode>
    <datasource>url</datasource>
    <onlinecode>200</onlinecode>
    <onlinemessage>Sukses</onlinemessage>
</response>

Description

status : 1= ok , 0 = tidak ok 
code : 200 = success, selain 200 = tidak success
message : keterangan mesage keluaran (untuk kesalahan dalam hit API akan muncul 
          Operasi program: gagal diproses)
          selain itu untuk logic akan ada di elemen data
data : merupakan 
datapath : 

Kolom Response	Keterangan
status	1 : ok , 2: tidak ok
code	200 : success, 10023 : kesalahan dalam pelemparan API
message	keterangan keluaran (untuk kesalahan dalam hit API akan muncul pessan Operasi Program : gagal diproses), selain itu untuk logic akan ada di elemen data
data	data keluaran dari API yang di hit, bisa berupa pesan logic maupun keluaran. Untuk data yang dienkripsi menggunakan base64
datapath	url yang dikirimkan
dataperiode	timestamp hit API
datasource	url menandakan akses api via url
onlinecode	isi sama dengan elemen code
onlinemessage	isi sama dengan elemen message

untuk parameter succes bisa menggunakan elemen response status yang berarti API sudah berhasil dipanggil, untuk pesan khusus misalnya validasi Yes or No atau Data sudah pernah di masukkan ada di elemen response data

Untuk testing bisa meggunakan aplikasi client seperti Postman / Insomnia atau client sejenis lainnya.