Pada halaman ini, akan dijelaskan penggunaaan API untuk mengambil data area (province, city, district, post code)
API Search Area
Method ini digunakan untuk mendapatkan data area yang mencakup provinsi, kota, kecamatan dan post code. API ini digunakan untuk rekomendasi area untuk customer.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/courier/area/search/{id_user}/{keyword} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | keyword | YA | STRING | Katak kunci untuk mencari area |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "Data retrieved successfully",
"data": [
{
"compositeName": "Bali, Kab. Gianyar, Ubud, 80571",
"compositeCode": "PR001#C001#D0001#80571",
"id": "ae9ae8ea-acd9-11ec-b86f-f6f18f017643",
"province": "Bali",
"provinceCode": "PR001",
"city": "Kab. Gianyar",
"cityCode": "C001",
"district": "Ubud",
"districtCode": "D0001",
"postcode": "80571",
"created": null,
"updated": null
}
]
}API Province List
Method ini digunakan untuk mendapatkan data area provinsi di Indonesia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/courier/area/list-province/{id_user}/{offsite}/{limit} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | offsite | YA | int | offsite data |
| GET | limit | YA | int | limit data |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| GET | q | TIDAK | STRING | Parameter untuk pencarian |
Response
{
"items": [
{
"id": null,
"province": "Jawa Barat",
"provinceCode": "PR009",
"city": null,
"cityCode": null,
"district": null,
"districtCode": null,
"postcode": null,
"created": null,
"updated": null
}
]
}API City List
Method ini digunakan untuk mendapatkan data area kota di Indonesia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/courier/area/list-city/{id_user}/{offsite}/{limit} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | offsite | YA | int | offsite data |
| GET | limit | YA | int | limit data |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| GET | q | TIDAK | STRING | Parameter untuk pencarian |
| GET | province | YA | STRING | Kode Provinsi dari kota yang dicari |
Response
{
"items": [
{
"id": null,
"province": null,
"provinceCode": null,
"city": "Kab. Bekasi",
"cityCode": "C075",
"district": null,
"districtCode": null,
"postcode": null,
"created": null,
"updated": null
},
{
"id": null,
"province": null,
"provinceCode": null,
"city": "Kota Bekasi",
"cityCode": "C086",
"district": null,
"districtCode": null,
"postcode": null,
"created": null,
"updated": null
}
]
}API District List
Method ini digunakan untuk mendapatkan data area kecamatan di Indonesia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/courier/area/list-district/{id_user}/{offsite}/{limit} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | offsite | YA | int | offsite data |
| GET | limit | YA | int | limit data |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| GET | q | TIDAK | STRING | Parameter untuk pencarian |
| GET | province | YA | STRING | Kode Provinsi dari kecamatan yang dicari |
| GET | city | YA | STRING | Kode Kota dari kecamatan yang dicari |
Response
{
"items": [
{
"id": "ae9f5ef2-acd9-11ec-b86f-f6f18f017643",
"province": null,
"provinceCode": null,
"city": null,
"cityCode": null,
"district": "Babelan",
"districtCode": "D1317",
"postcode": null,
"created": null,
"updated": null
}
]
}API Post Code List
Method ini digunakan untuk mendapatkan data kode pos di Indonesia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/courier/area/list-postcode/{id_user}/{offsite}/{limit} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | offsite | YA | int | offsite data |
| GET | limit | YA | int | limit data |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| GET | q | TIDAK | STRING | Parameter untuk pencarian |
| GET | province | YA | STRING | Kode Provinsi dari kode pos yang dicari |
| GET | city | YA | STRING | Kode Kota dari kode pos yang dicari |
| GET | district | YA | STRING | Kode Kecamatan dari kode pos yang dicari |
Response
{
"items": [
{
"postcode_code": "17610",
"id": "ae9f5ef2-acd9-11ec-b86f-f6f18f017643",
"province": null,
"provinceCode": null,
"city": null,
"cityCode": null,
"district": null,
"districtCode": null,
"postcode": "17610",
"created": null,
"updated": null
}
]
}