Podrobný popis API

V jakých formátek a protokolech systém Maatrix komunikuje

Formáty

Systém Maatrix může přebírat a předávat data z jednotlivých vět v těchto formátech:

JSON vzorový příklad pro tento formát dat naleznete zde
XML Tento formát není doposud zpřístupněn
CSV

určen pro jednoduchou komunikaci např. při spuštění služeb přes SMS gateway. Nejde použít pro volání komunikačních služeb, které potřebují množinové vstupní proměnné

Tento formát není doposud zpřístupněn

 

Protokoly

Systém Maatrix komunikuje na těchto protokolech:

https

zprávy z externí aplikace do systému Maatrix jsou posílány na definovanou doménu a port, systém Maatrix odpovídá v podobě response (viz věty A+B, C+D, E+F, G+H, Z ze sekvenčního diagramu).

vyžádané asynchronní zprávy (viz. X, Y ze sekvenčního diagramu) jsou odesílány na adresu a port uvedené v SummaryChanel (věta A), resp. AnwserChannel (věta E)  
smtp 

zprávy z externí aplikace do Systému Maatrix jsou posílány na definovanou systémovou mailovou adresu, systém Matrix odpovídá response na mailovou adresu, ze které byla zpráva odeslána (viz věty A+B, C+D, E+F, G+H, Z ze sekvenčního diagramu).

vyžádané asynchronní zprávy (viz. X, Y ze sekvenčního diagramu) jsou odesílány na mailovou adresu uvedenou v SummaryChanel (věta A), resp. AnwserChannel (věta E)

Každý mail zasílaný externí aplikací systému Maatrix musí mít v Předmětu zprávy uveden klíčový výraz callAPI-Maatrix. Maily s jiným předmětem zprávy jsou ignorovány viz. příklad mailu
SMSGate

zpráva pro spuštění služby (A) může být z externí aplikace zaslána do systému Maatrix i v podobě SMS zprávy na vyhražené tel. číslo systému Maatrix.

Tento adapter není doposud zpřístupněn

Jednotlivé protokoly je možné kombinovat, tj. je možné zasílat zprávy do systému Maatrix pomocí protokolu https, ale pokud nemá externí aplikace otevřený port pro příjem zpráv ze systému Maatrix, je možné pro příjem zpráv ze systému Maatrix použít protokol smtp (tj. systém Maatrix aktivně oslovuje externí aplikaci za pomoci mailových zpráv).

 

Je tedy možné provádět různé způsoby spuštění komunikační služby Maatrix a získání výsledku běhu této služby. Například:

1) Spustit službu Maatrix na základě věty A za pomoci protokolu https, výsledek služby (věta X) zašle systém Maatrix (na základě údajů ve větě A) opět protokolem https na IP a port vystavené externí aplikací

2) Spustit službu Maatrix na základě věty A za pomoci protokolu https, výsledek služby (věta X) zašle systém Maatrix (na základě údajů ve větě A)  protokolem smtp na mailovou adresu, na které výsledek běhu očekává externí aplikace

3) Spustit službu Maatrix na základě věty A za pomoci protokolu https, externí aplikace ale nepožaduje aktivní zaslání výsledku služby, ale aktivně se v opakovaném cyklu dotazuje systému Maatrix na to, zda již komunikační služba skončila (věty E,F,Y sekvenčního diagramu)

 

Použití konkrétního formátu a konkrétních protokolů definuje tzv. typ interface - více informací zde.

 

Adresy, na kterých systém Maatrix očekává zprávy z externí aplikace 

Systém Maatrix má zveřejněné dvě skupiny příchozích adres:

SandBox Adresy určené pro ladění vytvářených rozhraní v externích aplikacích. Na tyto adresy mohou být zasílány zprávy pouze z těch interface externích aplikací, které jsou ve stavu development (viz. tvorba interface). Zprávy z jiných interface budou odmítnuty.
https https://in-maatrix1.com:9951
smtp  Tato e-mailová adresa je chráněna před spamboty. Pro její zobrazení musíte mít povolen Javascript. - mail musí mít v předmětu zprávy klíčový výraz callAPI-Maatrix, v opačném případě je ignorován.  
Production Adresy určené pro testování externích interface a pro ostrý provoz systému. Na tyto adresy mohou být zasílány zprávy pouze z těch interface externích aplikací, které jsou ve stavu testing a open (viz. tvorba interface). Zprávy z jiných interface budou odmítnuty.
https https://in-maatrix1.com:9971
smtp  Tato e-mailová adresa je chráněna před spamboty. Pro její zobrazení musíte mít povolen Javascript. - mail musí mít v předmětu zprávy klíčový výraz callAPI-Maatrix, v opačném případě je ignorován.