API Documentation¶
Kontrak REST antara klien (Flutter, Web) dan NestJS backend.
Sumber kebenaran¶
| Sumber | Status | Path |
|---|---|---|
| OpenAPI JSON | Draft — belum final | backend/docs/openapi.json |
| API Standard | Normatif | backend/docs/API_STANDARD.md |
| Implementasi aktual | Runtime truth | backend/src/**/*.controller.ts |
| Snapshot TODO | Audit endpoint | backend/TODO.md |
Aturan lintas tim: Kontrak API harus distabilkan sebelum screen Flutter operasional massal (TODO.md).
Autentikasi¶
| Header | Kapan |
|---|---|
Authorization: Bearer <jwt> |
Semua route tenant-aware setelah login |
| JWT-1 | Setelah /auth/sesi — tanpa tenant |
| JWT-2 | Setelah /tenants/{kode}/pilih — berisi tenant_kode, peran, dll. |
Rujuk 10-ARSITEKTUR-KLIEN-AUTH-REALTIME.md.
Kelompok endpoint (ringkas)¶
| Domain | Base | Contoh |
|---|---|---|
| Health | /api/health |
GET |
| Auth | /api/auth |
POST sesi |
| Tenant | /api/tenants |
GET, POST /{kode}/pilih |
| Modul | /api/modul |
GET saya |
| Master | /api/master |
barang, kontak, lokasi, akun, … |
| Transaksi | /api/transaksi |
/:jenis, /:jenis/:id |
| Laporan | /api/laporan |
stok, penjualan, aging |
| Dashboard | /api/dashboard |
per peran |
| Ops CDC | /api/ops/cdc |
jobs (control plane) |
TODO dokumentasi API¶
- [ ] Generate OpenAPI dari decorator NestJS (CI)
- [ ] Dokumen error code standar per domain
- [ ] Webhook / SSE contract (AGENT_PROMPT_SSE)
- [ ] Versioning strategy (belum diputuskan)
Lihat TODO.md.