Pada halaman ini, akan dijelaskan penggunaaan API untuk berinterakasi dengan tabel Sender.
API List
Method ini digunakan untuk mendapatkan data sender yang tersedia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/sender/senders/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": 128,
"data": [
{
"deleted_at": null,
"id": "016fb505-f09c-422b-99ba-8b4f4860ebf9",
"phone": "62812-1952-0190",
"name": "DAcc",
"code": null,
"address": null,
"area": null,
"created": {
"date": "2022-05-06 13:35:14.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-05-06 13:35:14.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "",
"updatedBy": "",
"createdByName": null,
"updatedByName": null
}
]
}
API Create
Method ini digunakan untuk memasukan data sender.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/sender/senders/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 sender |
| POST | phone | YA | STRING | Nomor Telepon sender |
| POST | address | YA | STRING | Alamat sender |
| POST | area_id | TIDAK | STRING | Id area |
| POST | code | TIDAK | STRING | Code Sender |
Response
{
"message": "Data added successfully",
"data": {
"deleted_at": null,
"id": "ccc27f0a-99f4-4aaa-913c-1973bda2e2f9",
"phone": "628121217731",
"name": "Sender Test 1",
"code": null,
"address": null,
"area": null,
"created": {
"date": "2022-10-10 14:27:47.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 14:27:47.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 sender. Pada API ini, data yang bisa diubah hanya Phone Number saja.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/sender/senders/update/{id_user}/{id_senders} |
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_senders | YA | STRING | 36 character id sender |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | phone | YA | STRING | Nomor telepon sender |
Response
{
"message": "Data updated successfully",
"data": {
"deleted_at": null,
"id": "ccc27f0a-99f4-4aaa-913c-1973bda2e2f9",
"phone": "628121217732",
"name": null,
"code": null,
"address": null,
"area": null,
"created": {
"date": "2022-10-10 14:27:47.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 14:29:02.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"updatedBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"createdByName": null,
"updatedByName": null
}
}
API Details
Method ini digunakan untuk mendapatkan data details sender.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/sender/senders/details/{id_user}/{id_senders} |
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_senders | YA | STRING | 36 character id sender |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "Data retrieved successfully",
"data": [
{
"deleted_at": null,
"s_name_id": "df21cabb-1fa4-4739-8020-dbff127df227",
"s_address_id": null,
"id": "ccc27f0a-99f4-4aaa-913c-1973bda2e2f9",
"phone": "628121217731",
"name": "Sender Test 1",
"code": null,
"address": null,
"area": null,
"created": {
"date": "2022-10-10 14:27:47.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 14:27:47.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"updatedBy": "",
"createdByName": "Andika Pratama",
"updatedByName": null
}
]
}
API Delete
Method ini digunakan untuk menghapus data sender.
Request
| METHOD | URL |
|---|---|
| DELETE | http://apiv2.mitrabunso.com/public/sender/senders/delete/{id_user}/{id_senders} |
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_senders | YA | STRING | 36 character id sender |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "data deleted successfully"
}