Úvod, příklad

Upravit obsah stránky

Služby, které systém Flexideo zpracovává, nejsou volány prostřednictvím standardního rozhraní
solve
(používaného pro běžné požadavky Flexideo XML protokolu), ale pomocí specializovaného rozhraní
soap

Základní struktura GET části HTTP požadavku má následující podobu:
 https://{flexideo}/soap/{$typVolani}[/{$nazevAkce}]
 

Kde:
    bullet

    {$typVolani} označuje typ služby (např. service, table, form)

    bullet

    {$nazevAkce} je název volané akce nebo služby


Význam jednotlivých typů volání a jejich použití je podrobně rozebrán v následujících částech dokumentace. 

V tomto příkladu se zaměříme na službu pro zpracování plateb, která je v systému Flexideo implementována jako transformační akce.

Volání služby zpracování plateb

Konkrétní způsob zpracování není z pohledu volajícího důležitý – podstatné je, že jde o interní typ akce, kterému musí být předán parametr pdk-list, tj. seznam primárních klíčů dokumentů plateb, jež mají být zpracovány. 

Jako každá služba volaná přes HTTP protokol, i zde má požadavek dvě části:
    bullet

    GET část s adresou služby:

     https://muj-web.cz/soap/table/platby_zpracovani_4567
    

    bullet

    POST část obsahující tělo požadavku ve formátu SOAP Envelope.
    Tento požadavek zahrnuje potřebná data, například:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:act="http://www.flexideo.cz/schema/action">
  <soapenv:Body>
    <act:action>
      <act:session>abcdef123456</act:session>
      <act:pdk-list>123;124</act:pdk-list>
    </act:action>
  </soapenv:Body>
</soapenv:Envelope>

Příklad odpovědi

Po zpracování požadavku může být odpověď serveru např. ve formě:
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:act="http://www.flexideo.cz/schema/action">
  <soapenv:Body>
    <act:redirect>https://muj-web.cz/result/platby/summary</act:redirect>
  </soapenv:Body>
</soapenv:Envelope>

Poznámky k architektuře a autentizaci

Interní služby typu table a form mají vždy předem definovanou strukturu, kterou lze ověřit podle přiloženého XSD schématu dané akce. 

Naopak volně definované akce mohou mít vlastní specifikace – i ty jsou však popsány prostřednictvím WSDL dokumentu uloženého v odpovídajících složkách. Systém Flexideo přiděluje každé aktivní relaci (seanci) jedinečný identifikátor, který se při běžné komunikaci zapisuje do atributu session kmenového uzlu. 

Pokud je požadavek odesílán přes SOAP bránu, lze na tuto relaci navázat – identifikátor session se pak jednoduše vloží do příslušného uzlu SOAP zprávy a zachová se tak kontext aktuálního přihlášení. 

 V další části dokumentace bude podrobně vysvětlen význam jednotlivých parametrů a způsob registrace služeb v systému.