Respons

Penjelasan mengenai respons yang diberikan oleh API Kodeposku.

Format Respons

Semua respons dari API Kodeposku menggunakan format JSON. Berikut adalah contoh respons:

1{
2  "code": 200,
3  "message": "success",
4  "data": [
5    {
6      "id": 0,
7      "kode_kemendagri": "00.00.00.0000",
8      "kode_pos": 12345,
9      "kelurahan": "Nama Kelurahan",
10      "kecamatan": "Nama Kecamatan",
11      "kota": "Nama Kota / Kabupaten",
12      "provinsi": "Nama Provinsi",
13      "zona_waktu": "WIB / WITA / WIT",
14      "lintang": -1.234567,
15      "bujur": 91.234567,
16      "eleveasi": 1234
17    }
18  ],
19  "meta": {
20    "count": 1,
21    "timestamp": "2021-01-01T00:00:00.000Z"
22  }
23}

Kode Status

Kode status HTTP digunakan untuk menunjukkan apakah permintaan yang Anda lakukan berhasil atau tidak. Jika permintaan berhasil, maka respons akan memuat data seperti yang ditunjukkan pada bagian Format Respons. Jika permintaan gagal, maka respons akan memuat pesan error. Berikut adalah daftar kode status HTTP yang mungkin Anda dapatkan:

Kode	Pesan	Deskripsi
200	OK	Permintaan berhasil dilakukan dan data yang diminta tersedia.
400	Bad Request	Permintaan yang dikirim tidak sesuai dengan spesifikasi.
401	Unauthorized	API Key yang digunakan tidak valid atau tidak ditemukan.
403	Forbidden	API Key yang digunakan tidak valid atau sudah kadaluarsa.
404	Not Found	Data yang diminta tidak ditemukan.
429	Too Many Requests	Permintaan yang dikirim sudah melebihi batas maksimal. Lihat bagian Limitasi.
500	Internal Server Error	Terjadi kesalahan pada server. Silakan coba beberapa saat lagi.

Limitasi

Untuk menghindari penyalahgunaan, layanan API Kodeposku memiliki rate limit yaitu maksimal 100 request per menit. Jika Anda melebihi batas ini, tunggu beberapa saat sebelum melakukan request kembali.