API.ERP — Wprowadzenie
API.ERP udostępnia dane i procesy systemów klasy ERP (FK, WMS, HR, ESM) w czterech trybach, w zależności od charakteru integracji.
| Tryb | Kiedy używać | Charakter | Dokumentacja |
|---|---|---|---|
| Żądaniowy (REST) | Integrator potrzebuje konkretnych danych na żądanie (np. pobranie/zmiana pojedynczego zasobu) | Synchroniczny, request/response | Tryb żądaniowy |
| Rozgłoszeniowy | Integrator chce dostawać pełną zawartość zasobu natychmiast po zmianie, bez odpytywania | Asynchroniczny, push pełnego zasobu, sterowany zdarzeniami w systemach dziedzinowych | Tryb rozgłoszeniowy |
| Notyfikacyjny | Integrator chce tylko wiedzieć o zmianie (bez treści), a pełne dane pobiera na żądanie | Asynchroniczny, push samego powiadomienia (awizo) — lżejszy wariant trybu rozgłoszeniowego | Tryb notyfikacyjny |
| Raportowy | Integrator potrzebuje dużych wolumenów danych analitycznych, poza modelem transakcyjnym | Asynchroniczny, zlecenie → wynik w repozytorium integratora | Tryb raportowy |
Rozgłoszeniowy i Notyfikacyjny działają naprzemiennie — dla danego zasobu obowiązuje zawsze tylko jeden z nich, ustalony w ramach integracji.
Wszystkie tryby współdzielą ten sam model kanoniczny (zasoby, CodeableConcept, Reference, Identifier) opisany w Zasoby i Systemy kodowania — różni je wyłącznie sposób dostarczenia danych integratorowi, nie kształt samych danych.
Wspólny wzorzec: trzy role
We wszystkich trybach powtarza się ten sam układ ról:
- Aplikacja integratora — konsument API, po stronie zewnętrznego systemu.
- API.ERP — warstwa pośrednicząca, tłumacząca model kanoniczny na wywołania do systemów dziedzinowych i odwrotnie.
- Systemy dziedzinowe (FK, WMS, HR, ESM) — źródła prawdy dla danych biznesowych.
Tryby różnią się tym, kto inicjuje przepływ (integrator w trybie żądaniowym i raportowym, system dziedzinowy w trybie rozgłoszeniowym i notyfikacyjnym) i gdzie ląduje wynik (bezpośrednio w odpowiedzi, w repozytorium zasobów, w repozytorium raportów integratora).