/
Public API CRUD Group Kendaraan

Public API CRUD Group Kendaraan

Owned by Muhammad Iqbal Syams, created
Last updated: Jun 11, 2024 by Bintang Agung (Unlicensed)

Initiative owner

@Muhammad Iqbal Syams @Bintang Agung (Unlicensed)

UI/UX Designer

None

Commercial Stakeholder

Rendi Bahri

Target Release

 

Epic

https://mceasy.atlassian.net/browse/DEVPROJECT-4507

Updated Details

  • create document - 30 May 2024

Status

Ready to develop

Approval or Reviewed

[Tech Lead] @William Eka Tjipta
[Quality Assurance] @Aldiza Muhammad Satria
[CPM Lead] @Rizka Nugroho

Related Docs

 Target Population

Alam Sampurna Makmur(ASM) sebagai perusahaan transporter memiliki kendaraan-kendaraan yang dedicated maupun oncall kepada customernya. sehingga akan sering mengubah grup kendaraan karena berhubungan dengan billing/pembayaran kepada customer mereka.

ASM mengalami kesulitan dengan double kerja karena harus melakukan input data group kendaraan secara terpisah di dalam ERP dan platform McEasy. Selain itu, kemungkinan kesalahan input jika menggunakan 2 platform terpisah sangat besar.

 Business Value

Mengurangi effort dalam mengelola data grup kendaraan dalam 2 platform yang berbeda dan menghilangkan kemungkinan ketidaksinkronan data grup kendaraan. Hal ini juga memungkinkan dialami oleh customer McEasy yang lain dimana mereka memiliki platform ERP sendiri yang membutuhkan integrasi grup kendaraan.

 Proposed solution

Integrasi menggunakan Public API Grup Kendaraan akan memungkinkan sinkronisasi otomatis antara kedua platform ini, sehingga dapat mengurangi kesalahan dan double kerja yang tidak perlu. Perubahan data di ERP ASM dapat direkleksikan secara otomatis di dalam platform McEasy.

 

image-20240530-045425.png

 

 Milestones

 Success Criteria

  • customer dapat menggunakan public API untuk Grup Kendaraan agar data terintegrasi ke platform McEasy

  • dokumentasi API dapat dimengerti customer

Requirement Detail

User Story

Importance

Mockup

Details

User Story

Importance

Mockup

Details

As a client, I want to manage data vehicle group from public API, so that I can manage the datas from my ERP https://mceasy.atlassian.net/browse/DEVPROJECT-4508

must have

None

Brief

Pembuatan public API untuk grup kendaraan

User flow / System Flow

System ERP client → Request Public API → Process in McEasy → Response the API to ERP client

Expected results

  1. Perlu dipastikan bahwa API harus punya token Authentication sehingga user hanya bisa mengelola grup kendaraan miliknya sendiri, tidak bisa grup kendaraan dari company lain

  2. Jika error, menampilkan error message standart seperti yang sudah ada, misalnya jika id grup kendaraan dan id kendaraan tidak ada

  3. dokumentasi endpoint pada dokumen integrasi Public API McEasy (VSMS) pada https://vsms-v2-public.mceasy.com/docs/#/

    1. Get List Vehicle Group

    2. Create Vehicle Group

    3. Update Vehicle Group

    4. Delete Vehicle Group

  4. Get All Vehicles Group - GET https://[domain].com/settting/vehiclesgroup

    1. [ { "name": "Default", --> nama grup kendaraan "id": 5122, --> id grup kendaraan "vehicleList": [ --> list kendaraan dalam grup tersebut { 21444, 21445, 21442, 21434, 21447, } ] }, { "name": "Vendor 1", "id": 5449, "vehicleList": [] } ]

  5. Create a Vehicle Group - POST https://[domain].com/setting/vehiclesgroup/create

    1. { "input": { "name": "create vehicle grup baruu", --> Nama grup kendaraan "vehicleList": [ --> list id kendaraan apa saja yang ada 27651, 26508, 20655, 20772, 21444, 29274, 29277 ] } }

  6. Update a Vehicle Group - PATCH https://[domain].com/setting/vehiclesgroup/update/[id]

    1. { "input": { "id": 6223, --> Id grup kendaraan yang diubah "name": "updatee Group vehicle", --> Nama grup kendaraan "vehicleList": [ --> list id kendaraan apa saja yang ada 27651, 26508, 20655, 20772, 21444, 29274, 29277 ] } }

  7. Delete Vehicles Group - DEL https://[domain].com/setting/vehiclesgroup/[id]

    1. { "input": { 6225 --> id grup kendaraan yang dihapus } }