type basic: JSON - to Maatrix=https, to App=smtp
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.
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 https. 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
 |
 |
 |
|
 |
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) - 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 |
||
 |
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)– 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. |