116 lines
3.5 KiB
Markdown
116 lines
3.5 KiB
Markdown
# Product Engineering API Docs Index
|
|
|
|
Dokumentasi ini menjadi pintu masuk utama untuk tim backend dan frontend yang mengintegrasikan Odoo 19 Product Engineering dengan IFC Viewer.
|
|
|
|
Seluruh dokumen pada folder ini bersifat rekomendasi implementasi.
|
|
Dokumen dapat direview dan direvisi untuk menyesuaikan implementasi terbaru.
|
|
|
|
## Dokumen Utama
|
|
|
|
1. Backend technical developer guide:
|
|
[BACKEND_TECHNICAL_GUIDE.md](BACKEND_TECHNICAL_GUIDE.md)
|
|
|
|
2. Frontend technical developer guide:
|
|
[FRONTEND_TECHNICAL_GUIDE.md](FRONTEND_TECHNICAL_GUIDE.md)
|
|
|
|
3. API quick reference (cheat sheet):
|
|
[API_QUICK_REFERENCE.md](API_QUICK_REFERENCE.md)
|
|
|
|
4. Terminology and conventions (single source of truth):
|
|
[TERMINOLOGY_AND_CONVENTIONS.md](TERMINOLOGY_AND_CONVENTIONS.md)
|
|
|
|
## Catatan Scope
|
|
|
|
- Implemented: alur dokumen IFC, approval, BoM, inventory, procurement, MO pipeline, dan temp signed URL.
|
|
- Roadmap: fitur lanjutan seperti quality domain khusus, ECO, visual revision comparison, dan AI recommendation.
|
|
|
|
## Peta Endpoint
|
|
|
|
### Session
|
|
|
|
- Primary login authentication: /api/session/login
|
|
- Standard Odoo login fallback: /web/session/authenticate
|
|
- /api/session/login
|
|
- /api/session/logout
|
|
- /api/session/me
|
|
|
|
### Document IFC
|
|
|
|
- /api/ifc/documents/list
|
|
- /api/ifc/documents/create
|
|
- /api/ifc/documents/revise
|
|
- /api/ifc/documents/parse
|
|
|
|
### Approval Workflow
|
|
|
|
- /api/ifc/documents/approval/request-validation
|
|
- /api/ifc/documents/approval/submit
|
|
- /api/ifc/documents/approval/approve-production
|
|
- /api/ifc/documents/approval/approve-provisioning
|
|
- /api/ifc/documents/approval/reject
|
|
- /api/ifc/documents/approval/back-draft
|
|
|
|
### Activity
|
|
|
|
- /api/ifc/documents/activities/add
|
|
- /api/ifc/documents/activities/list
|
|
|
|
### BoM
|
|
|
|
- /api/ifc/documents/bom/generate
|
|
- /api/ifc/documents/bom/get
|
|
- /api/ifc/documents/bom/create-permanent-if-available
|
|
|
|
### Inventory and Procurement
|
|
|
|
- /api/ifc/documents/inventory/check
|
|
- /api/ifc/documents/inventory/create-draft-purchase
|
|
- /api/ifc/documents/inventory/create-product
|
|
|
|
### Manufacturing Order
|
|
|
|
- /api/ifc/documents/mo/create-from-permanent-bom (recommended)
|
|
- /api/ifc/documents/mo/create-if-available (compatibility alias)
|
|
- /api/ifc/documents/mo/check-all-availability
|
|
- /api/ifc/documents/mo/confirm-all-if-available
|
|
- /api/ifc/documents/mo/run-pipeline
|
|
- /api/ifc/documents/mo/pipeline-dry-run
|
|
|
|
### Temp IFC File
|
|
|
|
- /api/ifc/documents/temp-file
|
|
- /api/ifc/temp/<file_key>
|
|
|
|
## Alur Integrasi Cepat
|
|
|
|
1. Login sesi dengan endpoint session login.
|
|
2. Buat dokumen IFC dengan documents create.
|
|
3. Parse file IFC dengan documents parse.
|
|
4. Jika perlu, lakukan revisi dengan documents revise.
|
|
5. Jalankan approval bertahap sesuai role.
|
|
6. Buat activity dan monitor activity list.
|
|
7. Generate estimated BoM.
|
|
8. Create Permanent BoM jika availability Estimated BoM terpenuhi.
|
|
9. Create MO dari Permanent BoM (recommended: create-from-permanent-bom).
|
|
10. Cek availability all MOs dan summary material.
|
|
11. Confirm all MOs jika availability summary terpenuhi.
|
|
12. Minta signed URL temp-file dan load IFC ke viewer.
|
|
|
|
Catatan:
|
|
|
|
- Gunakan pipeline-dry-run untuk preview readiness tanpa perubahan data sebelum eksekusi real.
|
|
|
|
## Catatan Keamanan Penting
|
|
|
|
- Semua endpoint bisnis membutuhkan session user aktif.
|
|
- Temp file IFC hanya diakses melalui signed URL ber-expiry.
|
|
- Signed URL terikat ke document id dan user id.
|
|
- Frontend harus re-request temp-file jika URL expired.
|
|
|
|
## Rekomendasi Operasional
|
|
|
|
- Gunakan HTTPS di semua environment.
|
|
- Tambahkan monitoring error per endpoint.
|
|
- Audit role akses manager produksi dan provisioning secara periodik.
|
|
- Uji dokumen IFC ukuran besar saat UAT.
|