Dokumentasi API Sedata Sebantul
Berikut Dokumentasi untuk API Sedata Sebantul
Pengenalan
API ini menyediakan akses terhadap data di sedata sebantul. Dengan API ini, Anda dapat mengintegrasikan data sesuai kebutuhan Anda. api ini dirancang dengan standar REST dan mendukung format JSON untuk memudahkan pengembangan bagi masyarakat umum.
Base URL untuk semua endpoint: https://data.bantulkab.go.id/api
Endpoint Pengguna
GET
/instansi
Mendapatkan daftar semua instansi sedata sebantul.
Contoh Permintaan
GET https://data.bantulkab.go.id/api/instansi
Contoh Respons Sukses:
Response
cURL
{
"status": "success",
"message": "Data retrieved successfully",
"data": {
"count": 3,
"result": [
{
"instansi_cd": "99001",
"instansi_name": "Instansi 1"
},
{
"instansi_cd": "99002",
"instansi_name": "Instansi 2"
},
{
"instansi_cd": "99003",
"instansi_name": "Instansi 3"
}
]
}
}
curl --location '/api/instansi'
GET
/indikator
Mendapatkan daftar semua data perindikator sesuai instansi
header Parameter
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| X-instansi-Code | Integer | Ya | Code instansi sesuai data yang ingin cari |
Contoh Permintaan
GET https://data.bantulkab.go.id/api/indikator
Contoh Respons Sukses:
Response
cURL
{
"status": "success",
"message": "Data retrieved successfully",
"data": {
"count": 2,
"instansi": "opd1",
"links": {
"first": "https://data.bantulkab.go.id/api/indikator?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"currentPage": 1,
"from": 1,
"lastPage": 1,
"perPage": 10,
"to": 10
},
"result": [
{
"id data": "99.01.0011",
"nama data": "data contoh 1",
"pemutahiran": "1 bulan yang lalu",
"sub topik": "sub topik 1",
"cakupan": "Kabupaten Bantul"
},
{
"id data": "99.01.0012",
"nama data": "data contoh 2",
"pemutahiran": "1 bulan yang lalu",
"sub topik": "sub topik 2",
"cakupan": "Kabupaten Bantul"
},
]
}
}
curl --location 'https://data.bantulkab.go.id/api/indikator' \
--header 'X-instansi-Code: 99999'
GET
/indikator/{id data}
Mendapatkan data detail indikator
header Parameter
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| X-instansi-Code | Integer | Ya | Code instansi sesuai data yang ingin cari |
Contoh Permintaan
tambahakan patch parameter id data di akhir url
GET https://data.bantulkab.go.id/api/indikator/99.01.0099
Contoh Respons Sukses:
Response
cURL
{
"status": "success",
"message": "Data detail retrieved successfully",
"data": {
"count": 3,
"instansi": "op1",
"kategori": "Pekerjaan Umum dan Penataan Ruang",
"pemutahiran": "1 bulan yang lalu",
"result": [
{
"id data": "99.01.0099",
"nama data": "data contoh 1",
"data type": "indikator",
"data unit": "Persen",
"definisi": "definis 1.",
"value": [
{
"year": "2021",
"value": "47.68",
"status": "TW-4"
},
{
"year": "2022",
"value": "30.00",
"status": "tetap"
},
{
"year": "2023",
"value": "28.87",
"status": "tetap"
},
{
"year": "2024",
"value": "37.40",
"status": "tetap"
},
{
"year": "2025",
"value": " n/a ",
"status": "tidakada"
}
]
},
{
"id data": "99.01.0099.001",
"nama data": "A",
"data type": "variabel",
"data unit": "Hektar",
"definisi": "A1",
"value": [
{
"year": "2021",
"value": "284,16",
"status": "tetap"
},
{
"year": "2022",
"value": "168,32",
"status": "tetap"
},
{
"year": "2023",
"value": "161,96",
"status": "tetap"
},
{
"year": "2024",
"value": "209,84",
"status": "tetap"
},
{
"year": "2025",
"value": " n/a ",
"status": " - "
}
]
},
{
"id data": "99.01.0099.002",
"nama data": "B1",
"data type": "variabel",
"data unit": "Hektar",
"definisi": "B@",
"value": [
{
"year": "2021",
"value": "595,98",
"status": "tetap"
},
{
"year": "2022",
"value": "561,08",
"status": "tetap"
},
{
"year": "2023",
"value": "561,08",
"status": "tetap"
},
{
"year": "2024",
"value": "561,08",
"status": "tetap"
},
{
"year": "2025",
"value": " n/a ",
"status": " - "
}
]
}
]
}
}
curl --location 'https://data.bantulkab.go.id/api/indikator/99.01.0099' \
--header 'X-instansi-Code: 99999'
Kode Status
Berikut adalah daftar kode status HTTP yang mungkin dikembalikan oleh API.
| Kode | Deskripsi |
|---|---|
| 200 | Success: Permintaan berhasil |
| 401 | Unauthorized: Autentikasi diperlukan code instansi |
| 404 | Not Found: Data tidak ditemukan |
| 500 | Internal Server Error: Kesalahan server |