Jak použít API

type basic: JSON - to Maatrix=smtp, to App=smtp

Základní použití

Základní použití tohoto typu rozhraní je spuštění služby zasláním mailu obsahujícím větu A na mailovou adresu sytému Maatrix - ten reaguje mailovou odpovědí odesilateli obsahující větu 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.

Po skončení běhu komunikační služby zašle systém Maatrix mailem větu X s informací o ukončení běhu komunikační službu spolu s výsledky tohoto běhu. 

 

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 smtp (tedy zasíláním mailů). Adresy pro zasílání zpráv do systému Maatrix naleznete zde.

Aktivní zprávy ze systému Maatrix (informace o dokončení běhu komunikační služby, tj. věta X,  nebo výsledek dotazu, který čeká na dosažení konkrétního stavu běhu tj. věta Y) zasílá systém Maatrix na mailovou adresu uvedenou ve zprávě A (SummaryChanel - za předpokladu nastavení SendSummary=1) nebo ve zprávě E (AnswerChannel - za předpokladu nastavení WaitFor)

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 v těle mailu zaslaném na adresu systému Maatrix. 

B (call_response) – potvrzení spuštění komunikačníslužby / informace o chybách. Věta zaslána v těle mailu zaslaném odesilateli věty A. 

X (summary) - asynchronní informace o ukončení běhu komunikační služby Maatrix (pokud byla v A vyžádána) - touto zprávou systém Maatrix aktivně sděluje externí aplikaci, že došlo k ukončení běhu komunikační služby a externí aplikaci předává výsledky tohoto běhu. Formát JSON (v obsahu mailové zprávy), věta zaslána mailem na mailovou adresu uvedenou v hodnotě SummaryChannel ve větě A
  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 v těle mailu zaslaném na adresu systému Maatrix.

F (app_query_response)– synchronní odpověď systému Maatrix. Věta zaslána v těle mailu zaslaném odesilateli věty E.

Y (app_query_response)– asynchronní odpověď systému Maatrix (pokud byla v E vyžádána - viz hodnota WaitFor). Formát JSON (v obsahu mailové zprávy), věta zaslána mailem na mailovou adresu uvedenou v hodnotě AnswerChannel ve větě E.