Jak používat webové služby (API)

Datum poslední aktualizace: 02. 03. 2022
Pomohl Vám tento článek?
21 z celkových 25 článek pomohl.

Práce s webovými službami

  • Platforma Aptien.com poskytuje webové služby pro čtení dat a pro zápis dat do databáze   
  • Webové služby fungují pod konkrétním uživatelem 
  • Jejich oprávnění přístupu k datům jsou tedy dána rozsahem oprávnění uživatele (v konkrétní roli) 
  • Můžete buď využít existujícího uživatele (konkrétního člověka) nebo založit nového
  • Seznam volání jednotlivých webových služeb se zaznamenává v administraci Aptien.com pod konkrétním uživatelem
  • V administraci je seznam logů volání WS 
  • V logu je zaznamenán datum a čas volání WS, vstupní a výstupní parametry dané WS

Obecná pravidla pro webové služby

  • Pokud nejsou zadané všechny povinné vstupní parametry nebo vstupní parametry nejsou v odpovídající struktuře, výstupní zpráva na toto upozorní volající systém
  • Pokud žádný záznam nevyhovuje vstupním parametrům, výstupní zpráva bude prázdná
  • V případě, že nebude umožněn přístup k informacím, zpráva vrátí tuto informaci volajícímu systému
  • V případě jiné (např. systémové) chyby, vrátí služba tuto informaci volajícímu systému
  • Díky standardizaci jednotlivých komponent objektů služby, není striktně nutné zachování pořadí a výčet vstupních parametrů služeb

Uživatelé pro webové služby

  • Webové služby fungují pod konkrétním uživatelem
  • Můžete buď využít existujícího uživatele (konkrétního člověka, například Jan Novák) nebo založit nového a pojmenovat jej po aplikaci, která ji využívá (například Webová služba aplikace XY)
  • Změny v datech nesou auditní stopu a tedy všechny změny v datech provedené pod konkrétním uživatelem nesou informaci o tom, že ten konkrétní uživatel změny provedl. Pokud tedy webová služba provádí změny v datech pod uživatelem „Jan Novák“ , bude u změn označen „Jan Novák jako autor změn"

Doporučení k použití webových služeb

  • Založte nového uživatele
  • Nazvěte jej podle aplikace, která WS volá (Například. Personální systém) 
  • WS se zaloguje pod tímto uživatelem a všechny změny bude provádět pod tímto jménem 

Kde a jak jsou webové služby dostupné

  • Webové služby jsou přístupné na serveru ve WSDL standardu 
  • Jsou dostupné každému uživateli, který je může používat v rozsahu svého oprávnění. Nedostane se tedy k webovým službám, na které nemá oprávnění
  • Na URL adrese /ws.wsdl
  • Každý zákazník je má dostupné na adrese: https://INSTANCEZAKAZNIKA.aptien.com/ws.wsdl