Pada halaman ini, akan dijelaskan penggunaaan API untuk berinterakasi dengan tabel Customer.
API List
Method ini digunakan untuk mendapatkan data customer yang tersedia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/customer/customers/list/{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 | orderBy | TIDAK | STRING | Parameter untuk pengurutan berdasarkan data |
Response
{
"message": "Data retrieved successfully",
"show": "1",
"total": 17568,
"data": [
{
"deleted_at": null,
"id": "484193d5-b38c-48ad-bce7-3e773581a303",
"phone": "6281382988890",
"name": "Efendy Wijaya",
"address": "Jalan budi mulia gang e2 rt 03 rw 10 no 12, KOTA JAKARTA UTARA, PADEMANGAN, DKI JAKARTA, ID, 14420",
"area": "",
"created": {
"date": "2022-05-18 10:56:10.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-05-18 10:56:10.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "",
"updatedBy": "",
"createdByName": null,
"updatedByName": null
}
]
}
API Create
Method ini digunakan untuk memasukan data customer.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/customer/customers/create/{id_user} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 charakter id user |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | name | YA | STRING | Nama customer |
| POST | phone | YA | STRING | Nomor Telepon customer |
| POST | address | YA | STRING | Alamat customer |
| POST | area_id | YA | STRING | Id area |
Response
{
"message": "Data added successfully",
"data": {
"deleted_at": null,
"id": "851865f9-79ea-4d10-84ae-78c70deec76e",
"phone": "6281212121991",
"name": "Cust test 1",
"address": "JL. Test 1",
"area": "ae9bb96e-acd9-11ec-b86f-f6f18f017643",
"created": {
"date": "2022-10-10 14:01:52.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 14:01:52.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"updatedBy": "",
"createdByName": null,
"updatedByName": null
}
}
API Update
Method ini digunakan untuk mengubah data customer. Pada API ini, data yang bisa diubah hanya Phone Number saja.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/customer/customers/update/{id_user}/{id_customers} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_customers | YA | STRING | 36 character id customer |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | phone | YA | STRING | Nomor telepon customer |
Response
{
"message": "Data updated successfully",
"data": {
"deleted_at": null,
"id": "484193d5-b38c-48ad-bce7-3e773581a303",
"phone": "6281382988891",
"name": null,
"address": null,
"area": null,
"created": {
"date": "2022-05-18 10:56:10.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 14:04:49.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "",
"updatedBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"createdByName": null,
"updatedByName": null
}
}
API Details
Method ini digunakan untuk mendapatkan data details customer.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/customer/customers/details/{id_user}/{id_customers} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_customers | YA | STRING | 36 character id customer |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "Data retrieved successfully",
"data": [
{
"deleted_at": null,
"c_name_id": "6a103247-cc1e-4253-82d9-3731e836d5fc",
"c_address_id": "0008dc28-9929-4c72-a4cf-532508e2cfe1",
"id": "484193d5-b38c-48ad-bce7-3e773581a303",
"phone": "6281382988890",
"name": "Efendy Wijaya",
"address": "Jalan budi mulia gang e2 rt 03 rw 10 no 12, KOTA JAKARTA UTARA, PADEMANGAN, DKI JAKARTA, ID, 14420",
"area": "",
"created": {
"date": "2022-05-18 10:56:10.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-05-18 10:56:10.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "",
"updatedBy": "",
"createdByName": null,
"updatedByName": null
}
]
}
API Delete
Method ini digunakan untuk menghapus data customer.
Request
| METHOD | URL |
|---|---|
| DELETE | http://apiv2.mitrabunso.com/public/customer/customers/delete/{id_user}/{id_customers} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_customers | YA | STRING | 36 character id customer |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "data deleted successfully"
}