Bu bölüm Cluster ERP sunucusunun /api/v1 altında sunduğu HTTP API'yi belgeler; içerik src/cluster_erp/modules/*/ ve src/cluster_erp/server/ içindeki yönlendiricilerden çıkarılmıştır. Bölümde dört ortak sayfa, modüller dışındaki yollar için iki sayfa ve arka uç modülü başına bir sayfa vardır. İş anlamı iş modülleri bölümündedir; bu bölüm yolları, yetkileri, şemaları, durum kodlarını ve hata kodlarını kapsar.
Ortak sayfalar¶
| Sayfa | Tür | Kapsam |
|---|---|---|
| API'ye genel bakış | açıklama | Temel yollar, modül önekleri, OpenAPI erişilebilirliği, içerik türleri ve bir isteğin yolu |
| Kimlik doğrulama ve başlıklar | başvuru | Kimlik bilgileri, çerezler, kiracı seçimi, dil, kullanımdan kaldırma ve denetim başlıkları |
| API kuralları | başvuru | Sayfalama, filtreleme, para, kimlikler, geçici silme, toplu işlemler, eylemler ve durum kodları |
| Hatalar | başvuru | Hata gövdesi, istisna işleyicileri ve her hata kodu |
| İş hata kodları | başvuru | Çekirdek hata modülünün iş bölümlerindeki hata kodları |
Modüller dışındaki yollar¶
| Sayfa | Uç noktalar | Kapsam |
|---|---|---|
| Sistem uç noktaları | 28 | Sağlık, hazır olma, security.txt, meta veri, modül listesi, görüntüleme anahtarları, kayıt ve operatör konsolu |
| Paylaşılan sunucu yolları | 40 | Notlar, ekler, e-posta, sohbet, bileşik taraf oluşturma, taraf rolleri ve kiracı alanları |
Modül sayfaları¶
src/cluster_erp/modules/ içinde module.py dosyası olan her paket için bir sayfa. Uç nokta sayısı modülün register_routes ile bağladığı her yolu içerir. Dokuz procurement alt modül sayfasının satırları procurement satırından sonra gelir; sayıları toplamda modül sayısını verir.
| Modül | Temel yol | Uç noktalar | Sayfa |
|---|---|---|---|
analytics |
/api/v1/analytics |
47 | Analytics API |
app_store |
/api/v1/app_store |
13 | App store API |
auth |
/api/v1/auth |
56 | Auth API |
bom |
/api/v1/bom |
39 | BOM API |
calendars |
/api/v1/calendars |
23 | Calendars API |
costing |
/api/v1/costing |
30 | Costing API |
crm |
/api/v1/crm |
57 | CRM API |
currencies |
/api/v1/currencies |
20 | Currencies API |
design_engineering |
/api/v1/design_engineering |
20 | Design engineering API |
documents |
/api/v1/documents |
23 | Documents API |
fleet |
/api/v1/fleet |
116 | Fleet API |
intranet |
/api/v1/intranet |
117 | Intranet API |
inventory |
/api/v1/inventory |
51 | Inventory API |
logs |
/api/v1/logs |
9 | Logs API |
mail |
/api/v1/mail |
28 | Mail API |
nesting |
/api/v1/nesting |
27 | Nesting API |
owned_organisations |
/api/v1/owned_organisations |
28 | Owned organisations API |
parties |
/api/v1/parties |
53 | Parties API |
privacy |
/api/v1/privacy |
11 | Privacy API |
procurement |
/api/v1/procurement |
155 | Procurement API |
procurement (suppliers) |
/api/v1/procurement |
6 | Procurement API: Tedarikçiler uç noktaları (suppliers) |
procurement (substitution_groups) |
/api/v1/procurement |
10 | Procurement API: İkame grupları uç noktaları (substitution_groups) |
procurement (critical_materials) |
/api/v1/procurement |
6 | Procurement API: Kritik malzemeler uç noktaları (critical_materials) |
procurement (purchase_requests) |
/api/v1/procurement |
12 | Procurement API: Satın alma talepleri uç noktaları (purchase_requests) |
procurement (purchase_rfqs) |
/api/v1/procurement |
35 | Procurement API: Satın alma teklif talepleri uç noktaları (purchase_rfqs) |
procurement (purchase_orders) |
/api/v1/procurement |
18 | Procurement API: Satın alma siparişleri uç noktaları (purchase_orders) |
procurement (purchase_contracts) |
/api/v1/procurement |
16 | Procurement API: Satın alma sözleşmeleri uç noktaları (purchase_contracts) |
procurement (info_records) |
/api/v1/procurement |
8 | Procurement API: Satın alma bilgi kayıtları uç noktaları (info_records) |
procurement (mrp) |
/api/v1/procurement |
44 | Procurement API: MRP uç noktaları (mrp) |
production |
/api/v1/production |
102 | Production API |
products_and_services |
/api/v1/products_and_services |
55 | Products and services API |
projects |
/api/v1/projects |
64 | Projects API |
purchasing_quotations |
/api/v1/purchasing_quotations |
27 | Purchasing quotations API |
quotations |
/api/v1/quotations |
34 | Quotations API |
records |
/api/v1/records |
10 | Records API |
sales_orders |
/api/v1/sales_orders |
68 | Sales orders API |
subscriptions |
/api/v1/subscriptions |
20 | Subscriptions API |
Yol sayısı¶
Sunucu 1371 yol kaydeder; sayım kaynak dosyalardan yapıldı:
| Kaynak | Yollar | Sayım yöntemi |
|---|---|---|
src/cluster_erp/modules/** |
1292 | @<router>.get/post/put/patch/delete( dekoratörleri |
src/cluster_erp/modules/subscriptions/customer_subscriptions/routes.py |
4 | router.add_api_route( çağrıları |
src/cluster_erp/server/routes/currencies.py |
7 | dekoratörler; currencies modülü bağlar |
src/cluster_erp/server/routes/signup.py, src/cluster_erp/server/routes/vendor.py |
21 | dekoratörler; yalnız multi_tenant açıkken bağlanır |
src/cluster_erp/server/routes/ içindeki diğer dosyalar |
40 | dekoratörler |
src/cluster_erp/server/app.py |
7 | @app.get( dekoratörleri; biri yalnız multi_tenant kapalıyken vardır |
Bir yönlendirici adıyla başlayan 1360 yol dekoratörü (modüller ve server/routes/), düz bir grep aramasının döndürdüğü sayıdır. Modül sayfaları toplam 1303 yol listeler.
İlgili sayfalar¶
92f8051 numaralı commit ile 2026-11-13 tarihinde doğrulandı.