Návrh - špecifikácia vonkajších interfejsov

[Gurtas1]

Podrobná špecifikácia vonkajších interfejsov - ak aplikácia komunikuje s inými aplikáciami, súbormi, zariadeniami - tieto musia byť jasne a podrobne definované

[Gurtas1]

Podrobná špecifikácia externých interfejsov pre projekt "Accounts"

1. Autentifikácia

• API pre AIS login (Shibboleth 2, Zagiba) Ešte otázna implementácia
  • Účel: Vytvoriť bezpečný autentifikačný mechanizmus pre používateľov pomocou systému AIS (Access and Identity System).
  • Technológia: API založené na Shibboleth 2 pre overenie identity.

2. Synchronizácia údajov s tabuľkou Users v projekte "Pracovné cesty"

• Komunikácia medzi aplikáciou "Pracovné cesty" a "Accounts"

  • Účel: Umožniť aplikácii Pracovné cesty pri vytváraní účtu používateľa zároveň komunikovať s databázou Accounts pre automatickú synchronizáciu používateľov.
  • Technológia: API prístup pomocou API endpointov pre prístup k dátam
  • Postup:
    • Pri vytvorení nového účtu používateľa v aplikácii Pracovné cesty sa automaticky odošle požiadavka na API endpoint v aplikácii Accounts na aktualizáciu tabuľky Users.
    • V prípade zmeny údajov (meno, email) sa API endpoint v Accounts aktualizuje.
  • Formát dát: JSON objekt s poliami ID, meno, email, dátum vytvorenia, posledná aktualizácia.
  • Zabezpečenie: Použitie API tokenu pre overenie prístupu, aby bol prístup obmedzený len na oprávnené aplikácie.

• Import používateľov z tabuľky Users v "Pracovné cesty"

  • Účel: Importovať a synchronizovať existujúcich používateľov z aplikácie Pracovné cesty do aplikácie Accounts.
  • Technológia: SQL prístup
  • Postup:
    • Vytvoriť skript, ktorý na požiadanie odošle GET request na API endpoint v Pracovné cesty pre zoznam všetkých aktuálnych používateľov.
    • Údaje sa naimportujú do tabuľky Users v Accounts a ak existujú zmeny, tabuľka sa aktualizuje.
  • Formát dát: JSON zoznam používateľských objektov s informáciami ID, meno, email.
  • Zabezpečenie: Použitie API tokenu pre overenie prístupu, aby bol prístup obmedzený len na oprávnené aplikácie.

3. Synchronizácia údajov s tabuľkou SPP prvky v projekte "Pracovné cesty"

• Komunikácia medzi aplikáciou "Pracovné cesty" a "Accounts" pri vytváraní SPP prvku

  • Účel: Automatické pridanie SPP prvku do aplikácie Accounts, keď sa vytvorí nový záznam v Pracovné cesty.
  • Technológia: API endpoint pre pridávanie a úpravy údajov.
  • Postup:
    • Pri pridaní nového SPP prvku v Pracovné cesty sa odošle POST požiadavka na API v aplikácii Accounts, kde sa prvok pridá do databázy SPP prvky.
  • Formát dát: JSON objekt s informáciami o SPP prvku (ID, názov, label).
  • Zabezpečenie: Použitie API tokenu pre overenie prístupu, aby bol prístup obmedzený len na oprávnené aplikácie.

• Import všetkých existujúcich SPP prvkov z aplikácie "Pracovné cesty"

  • Účel: Synchronizácia a aktualizácia všetkých SPP prvkov medzi aplikáciami.
  • Technológia: script na získanie údajov cez API.
  • Postup:
  • Vytvoriť skript, ktorý na požiadanie odošle GET request na API endpoint v Pracovné cesty pre zoznam všetkých aktuálnych SPP prvkov. Nasledne ich aktualizuje v tabulke SPP prvky
  • Formát dát: JSON zoznam SPP objektov (ID, názov, label, dátum vytvorenia, dátum aktualizácie).
  • Zabezpečenie: Použitie API tokenu pre overenie prístupu, aby bol prístup obmedzený len na oprávnené aplikácie.