Media Type

Dalam API ini, penggunaan media-type JSON digunakan jika memungkinkan. Permintaan dengan message-body akan menggunakan JSON untuk mengatur atau memperbarui status sumber daya.

  • API ini menerima JSON dalam body request dan memerlukan pengaturan header Content-type: application/json untuk semua permintaan. API akan selalu merespons dengan objek JSON, kecuali jika dinyatakan sebaliknya. Bergantung pada konteksnya, sumber daya dapat dikembalikan sebagai objek tunggal atau sebagai array objek yang ada di dalam objek respons.

  • Header Content-type: application/json dan Accept: application/json harus diatur pada semua permintaan, kecuali ada pernyataan sebaliknya.

Request Codes

Contoh kode permintaan yang digunakan dalam demo adalah:

import requests 

# Making a GET request
r = requests.get('https://{baseUrl}/api/mastervehicle/merk')
print(r)
# print content of request
print(r.text)

Response Codes

Semua permintaan API akan merespons dengan kode status HTTP yang sesuai.

Klien API Anda harus menangani setiap kelas respons secara berbeda:

  • Kode 2XX adalah respons yang berhasil.

  • Kode 4XX adalah respons kesalahan klien, artinya ada kesalahan pada cara pengajuan permintaan, seperti parameter hilang atau nilai tidak valid. Anda harus mengubah permintaan sebelum mencoba lagi.

  • Kode 5XX adalah respons kesalahan server. Mungkin ada masalah sementara di sisi IBID, jadi Anda mungkin ingin mencoba lagi setelah beberapa penundaan.

Error Codes

Version Information

Tag versi digunakan untuk mengelola berbagai versi dari API. Nilai defaultnya adalah versi pertama yang dirilis.