/ API Kontakty

XML API komunikace


Co je XML komunikace v programu POHODA a k čemu slouží

XML komunikace je rozhraní programu POHODA, které umožňuje automatizovanou výměnu dat mezi systémem POHODA a externími aplikacemi.

Využívá strukturovaný formát XML pro přenos informací, což umožňuje snadnou integraci s dalšími systémy, jako jsou e-shopy, CRM, ERP nebo účetní software.


Hlavní účel XML komunikace:

  • Import dat do POHODY (např. objednávky, faktury, skladové zásoby, atd.).
  • Export dat z POHODY (např. seznam zásob, účetní doklady, adresář).
  • Automatizace procesů bez nutnosti ručního zadávání dat.
  • Integrace s externími systémy pro zajištění plynulého toku informací.

Základní vlastnosti komunikace:

  • Komunikační kanály: souborový systém nebo HTTP rozhraní (mServer).
  • Formát dat: komunikace probíhá pomocí XML souborů, které mají definovanou strukturu pomocí XSD schémat.
  • Validace: XML musí odpovídat XSD schématu programu POHODA.
  • Autentizace a autorizace: Každý požadavek je zpracován v kontextu konkrétního uživatele.
  • Podporované operace: import, export, update, delete.
  • Podpora filtrování, stránkování a omezení datového výstupu.
  • Možnost definovat vlastní XSLT transformace výstupních dat.

Jak funguje XML komunikace v programu POHODA

XML komunikace v programu POHODA funguje jako rozhraní pro výměnu dat mezi POHODOU a externími systémy.

Komunikace probíhá prostřednictvím strukturovaných XML souborů, které obsahují požadované informace ve formátu, který POHODA dokáže zpracovat.

Funguje na základě standardního principu XML požadavek – XML odpověď, který zajišťuje strukturovanou výměnu dat mezi externím systémem a aplikací POHODA.


Klikněte pro zobrazení
 

Průběh komunikace:

  • Vytvoření XML požadavku
    Externí aplikace vytvoří XML soubor podle specifikace POHODA (např. požadavek na import faktury nebo export skladových zásob).
  • Zpracování požadavku POHODOU
    POHODA načte XML soubor (např. ze složky DataBox nebo přes HTTP rozhraní) a provede požadovanou operaci – import, export, aktualizaci nebo smazání dat.
  • Vytvoření odpovědi
    POHODA vrátí odpověď ve formě XML souboru, který obsahuje výsledek operace (např. potvrzení o úspěšném importu, chybové hlášení nebo exportovaná data).
  • Volitelná transformace výstupu
    Výstupní XML může být transformováno pomocí XSLT do jiného formátu (např. HTML, CSV), pokud je to potřeba pro další zpracování.

Způsoby komunikace:

  • Souborová komunikace - výměna XML souborů přes definované složky.
  • HTTP komunikace - komunikace přes webové rozhraní (mServer).

Podrobnosti zpracování XML požadavku a odpovědi na import

Při načtení XML dokumentu POHODA nejprve ověřuje, zda dokument odpovídá XSD schématu. Nejprve se kontroluje obálka XML dokumentu (<dataPack>), následně jednotlivé elementy <dataPackItem>.

Při zpracování XML může dojít k nekorektním situacím, na které je uživatel upozorněn v odpovědi.
V elementu <importDetails> se nachází podrobnosti ke zpracování jednotlivého dokladu.
V elementu <detail> jsou uvedeny konkrétní chyby, včetně jejich kódu a popisu.

Podrobnější informace o zpracování XML požadavku najdete v sekci: Podrobnosti zpracování...