Přeskočit na hlavní obsah

Kapitola 6: Průvodce API a Integrací

6.1 Přehled​

Tato kapitola popisuje vlastní API endpointy poskytované modulem a jeho závislosti na jiných systémech.

6.2 Vlastní API Endpointy​

Modul vystavuje REST endpointy pro frontendové komponenty a externí integrace.

6.2.1 Vizualizace Hierarchie​

  • Endpoint: GET /ProductionOrder/ChildrenOf/:id
  • Třída Akce: Api\ProductionOrder\ChildrenOf
  • Odpověď: JSON stromová struktura obsahující:
    • Požadovanou Výrobní zakázku.
    • Všechny Podřízené Výrobní zakázky.
    • Všechny Operace seskupené podle Zakázky.
  • Případ Užití: Vykreslování "Stromového Pohledu" v UI.

6.2.2 Spouštěč Nákupu​

  • Endpoint: POST /ProductionOrder/orderBom/:id
  • Třída Akce: Api\ProductionOrder\OrderBom
  • Logika: Spouští OrderBomProcessor pro generování Objednávek a Kooperací.
  • Odpověď: Stav Úspěch/Chyba.

6.2.3 Řízení Životního Cyklu​

  • Endpoint: POST /ProductionOrder/takeFromWarehouse/:id

  • Třída Akce: Api\ProductionOrder\TakeFromWarehouse

  • Popis: Vynutí stav Zakázky na Dokončeno.

  • Varování: Tato akce obchází některé standardní hooky. Používejte s opatrností.

  • Endpoint: POST /ProductionOrder/:id/reset

  • Třída Akce: Api\ProductionOrder\Reset

  • Popis: Tvrdý reset Zakázky.

  • Efekt:

    • Smaže všechny záznamy WorkPerformed.
    • Smaže všechny záznamy GoodsReceipt.
    • Resetuje stavy Operací na Čekání.

6.3 Závislosti Modulu​

Výrobní modul je součástí těsně spojené sady ERP.

ZávislostTypKritičnostDopad Selhání
WarehouseManagementBackendVysokáJsou vyžadovány StockIssuerService a StockReceiverService. Bez nich selže ukládání WorkPerformed a Dokončení Zakázky, nebo se neaktualizuje sklad.
AccountingBackendStředníVyžadováno pro OrderBomProcessor k generování Objednávek. Pokud chybí, funkce "Objednat Kusovník" vyhodí chybu pro nakupované položky.
ProjectManagementBackendNízkáPoužito pro alokaci nákladů. Pokud chybí, pole projectId jsou během vytváření transakcí jednoduše ignorována.
AutoERP CoreFrameworkKritickáSpoléhá na ExtensionUtil a vlastní třídy ErrorFactory poskytované základním balíčkem AutoERP.

6.4 Integrační Scénáře​

6.4.1 Připojení k Externímu E-Shopu​

  • Cíl: Vytvořit Výrobní zakázky, když se prodá specifický produkt online.
  • Přístup:
    1. Použijte nástroje Workflow/BPM AutoERP.
    2. Spouštěč: Vytvořena SalesOrder (Objednávka Prodeje).
    3. Podmínka: SalesOrder obsahuje vyráběné položky.
    4. Akce: Vytvořit entitu ProductionOrder přes API (nebo Akci Workflow).
    5. Mapování Polí: Product -> Product, Quantity -> QuantityPlanned.

6.4.2 Připojení k Tabletům na Dílně​

  • Cíl: Pracovníci logují čas přes zjednodušené rozhraní.
  • Přístup:
    1. Vytvořte jednoduchý frontend (React/Vue) pro tablety.
    2. Přihlášení: Uživatel naskenuje odznak (ID Uživatele).
    3. Skenování: Uživatel naskenuje QR Kód Zakázky (ProductionOrder.id).
    4. Akce: Uživatel klepne na "Start". Frontend zavolá API pro vytvoření WorkPerformed ve stavu Návrh.
    5. Akce: Uživatel klepne na "Stop". Frontend aktualizuje WorkPerformed s trváním a materiálem.