Sebagian besar endpoint dalam API ini akan disimpan dalam cache yang berumur 12 jam.
Seluruh endpoint yang dapat dipanggil pada API ini memiliki format data berikut:
| Nama | Deskripsi |
|---|---|
data |
Data yang dikembalikan. Akan bernilai null apabila error tidak bernilai null |
error |
Pesan kesalahan yang terjadi. Akan bernilai null apabila data tidak bernilai null. |
Nilai data akan selalu memiliki dua key (kunci) berikut
| Nama | Deskripsi |
|---|---|
<nama_entitas> |
Entitas yang dicari |
version |
Tanggal pembaruan data. Memiliki format DD/MM/YYYY |
Setiap berkas markdown yang ada pada folder ini merupakan sebuah endpoint yang dapat dipanggil melalui /api/<nama_berkas>. Dokumentasi untuk masing-masing endpoint dapat dilihat melalui berkas markdown dengan nama yang sama.
Seluruh dokumentasi untuk endpoint yang tersedia memiliki format berikut:
Deskripsi singkat dari endpoint tersebut.
Daftar parameter yang dapat disematkan pada endpoint, beserta tipe data dan penjelasan mengenai parameter tersebut.
Parameter dapat disematkan dalam bentuk querystring atau disematkan dalam URL apabila endpoint memiliki parameter (contoh: xxx/:id mengharuskan :id diteruskan melalui URL)
Status HTTP kembalian yang mungkin dikembalikan, beserta deskripsi untuk masing-masing status HTTP yang mungkin dikembalikan oleh sebuah endpoint.
Bentuk objek dari data yang dikembalikan, beserta tipe data dan deskripsi untuk masing-masing key (kunci) yang terdapat pada objek tersebut.
Karena adanya perubahan bentuk sumber data untuk beberapa API, endpoint-endpoint yang mengalami perubahan daa akan memiliki parameter tambahan bernama version. Secara bawaan, endpoint akan menyajikan data versi lama untuk menjamin kompatibilitas dengan konsumen API.
Data versi lama akan dihapus secara permanen dalam waktu 6 bulan sejak versi data terbaru dirilis.