API Reference
Quick Summary
This document focuses on the endpoints most frequently used operationally.
For detailed example payloads + proof labels (mock/real/sanitized), see API Examples.
Swagger UI: Swagger UI OpenAPI spec: /openapi/adi-jaya.openapi.yaml Full endpoint coverage: API Full Catalog.
Source prefix:
RouteServiceProvider+ route files. Uncertain response schemas are marked requires verification and are recorded in the Verification Matrix.
Runtime Evidence Status
- Backend runtime hit while compiling this document: Not done yet (environment access not available in docs session).
- Current validation base: route file + controller source (
adi-jaya-master) with sanitization. - Impact: endpoint/path is relatively strong, but final payload remains Partial until runtime tested.
A. Admin Web Endpoints (/admin/*)
Web admins use session auth (web + auth) and access:* middleware.
Area: Projects
| Method | Path | Controller@Method | Access |
|---|---|---|---|
| GET | /admin/projects/list | ProjectListController@index | head_admin |
| GET | /admin/projects/create | ProjectController@index | head_admin |
| POST | /admin/projects/create | ProjectController@create | head_admin |
| PUT | /admin/projects/{project} | ProjectController@update | head_admin |
| DELETE | /admin/projects/{project} | ProjectController@destroy | head_admin |
Area: SPB
| Method | Path | Controller@Method | Access |
|---|---|---|---|
| POST | /admin/spbs/store | SPBController@store | projects |
| PATCHES | /admin/spbs/{spb}/update | SPBController@update | projects |
| PUT | /admin/spbs/{spb} | SPBController@updateStatus | head_admin |
| GET | /admin/spbs/list/{condition} | SPBListController@index | multi-role |
Area: PO
| Method | Path | Controller@Method | Access |
|---|---|---|---|
| GET/POST | /admin/po/{spb}/create | PoController@index | head_admin/logistic/logistic_admin |
| POST | /admin/po/{spb} | PoController@create | head_admin/logistic/logistic_admin |
| PUT | /admin/po/{po} | PoController@update | head_admin/logistic/logistic_admin |
| PUT | /admin/po/status/{po}/update | PoController@updateStatus | head_admin/project/spv/logistic/logistic_admin |
Area: PO Payment
| Method | Path | Controller@Method | Access |
|---|---|---|---|
| GET | /admin/payments/list/{condition} | PaymentPoListController@index | head_admin/accounting |
| PUT | /admin/payments/{po} | PaymentPoController@update | head_admin/accounting |
| PUT | /admin/payments/{payment}/approve | PaymentPoController@approve | head_admin/accounting_admin |
| PUT | /admin/payments/{payment}/verify | PaymentPoController@verify | head_admin |
Area: SPK
| Method | Path | Controller@Method | Access |
|---|---|---|---|
| GET | /admin/spk | SPKController@index | head_admin/spk/accounting |
| POST | /admin/spk/{project}/store | SPKController@store | spk |
| PATCHES | /admin/spk/{project}/{spk}/approve | SPKController@approve | head_admin |
| PATCHES | /admin/spk/{project}/{spk}/finish | SPKController@finish | head_admin |
B. API v1 (/api/v1/*)
Dominant auth: auth:sanctum.
Auth/User
| Method | Path | Controllers |
|---|---|---|
| POST | /api/v1/user/login | API\\V1\\Auth\\LoginController@login |
| POST | /api/v1/user/logout | API\\V1\\Auth\\LoginController@logout |
| PATCHES | /api/v1/user/firebase-token | API\\V1\\FCM\\FCMController@update |
Project/SPB/PO
| Method | Path | Controllers | Notes |
|---|---|---|---|
| GET | /api/v1/project | ProjectController@index | access project/spv |
| GET | /api/v1/project/list-spb | SPB PM Controller@index | SPB list |
| POST | /api/v1/project/spb/{spb_no} | SPB PM Controller@create | create SPB |
| PATCHES | /api/v1/project/spb/{spb_no} | SPB PM Controller@update | SPB updates |
| GET | /api/v1/project/spb/{spb_no}/po | POController@index | PO list per SPB |
| GET | /api/v1/project/list-po | POListController@index | PO list |
| POST/PATCH | /api/v1/project/spb/{spb_no}/po/{po_no} | POController@update | receive/complaint/approve/reject according to role |
Public-like utility API
| Method | Path | Controllers |
|---|---|---|
| GET | /api/v1/supplier | SupplierController@index |
| GET | /api/v1/project-list | ProjectController@list |
| GET | /api/v1/po-payment-receipt/po-list | POPaymentReceiptController@poList |
C. Membership API
Derived from routes/membership.php.
| Method | Path (indicative) | Controllers |
|---|---|---|
| POST | /membership/register | Membership\\RegisterController@store |
| POST | /membership/login | Membership\\LoginController@login |
| PATCHES | /membership/fcm | Membership\\FcmController@store |
| POST | /membership/otp/request | Membership\\OtpController@store |
| POST | /membership/otp/check | Membership\\OtpController@check |
Verification Notes
- Status: Partial
- Scope: Final prefix
routes/membership.phpin production depends on additional route loading in bootstrap/provider. - Action: Match the endpoint membership table with the runtime
route:listresults from the target server (refer toVM-001).