Jak použít API

type basic: JSON - to Maatrix=https, to App=N/A

Základní použití

Základní použití tohoto typu rozhraní je spuštění služby zasláním věty A na https adresu sytému Maatrix - ten reaguje odpovědí větou B, ve které je uvedeno, jestli byl běh komunikační služby spuštěn a pokud ne tak věta B obsahuje seznam chyb.

Systém Maatrix sám aktivně neinformuje externí aplikaci o ukončení běhu komunikační služby.

Externí aplikace zjistí informace o stavu a výsledku běhu komunikační služby dotazem - zasláním věty E na https adresu systému Maatrix. 

 

Formát

Tento typ rozhraní je určen pro komunikaci ve formátu JSON - příklad zprávy naleznete zde.

 

Protokol

Komunikace s tímto typem rozhraní předpokládá, že aplikace oslovuje systém Maatrix protokolem https. Adresy pro zasílání zpráv do systému Maatrix naleznete zde.

Aktivní zprávy systém Maatrix externí aplikaci neposílá.

Tento typ rozhraní neumožňuje nastavovací zprávy (ani z externí aplikace a ani ze systému Maatrix) a neumožňuje ani dotazovací zprávy ze systému Maatrix.

 

Seznam povolených zpráv

 interface ext app sl    interface maatrix sl  interface sequence
  interface A B X sl  

call – spuštění komunikační služby za pomoci externí aplikace.

A (call) oslovení externí aplikací - volání běhu komunikační služby. Formát JSON, věta zaslána jako zpráva na https. 

B (call_response) – potvrzení spuštění komunikačníslužby / informace o chybách

X (summary) - tato zpráva není v tomto typu rozhraní podporována

  interface E F Y r1 sl  

app_query – externí aplikace se dotazuje na vlastnosti spuštěné komunikační služby nebo na stav popř. výsledek ukončené komunikační služby

E (app_query)– dotaz externí aplikace na běh komunikační služby Maatrix. Systém Maatrix umožňuje opakované dotazy na běh komunikační služby - prodleva mezi jednotlivými dotazy musí být nejméně 10 vteřin - častější dotazy budou ignorovány. Formát JSON, věta zaslána jako zpráva na https.

F (app_query_response)– synchronní odpověď systému Maatrix

Y (app_query_response)– tato zpráva není v tomto typu rozhraní podporována