Podrobný popis API

Co je to rozhraní (callAPI) k systému Maatrix

Abychom si dále dobře rozuměli, uveďme schematický obrázek popisující všechny součásti rozhraní k systému Maatrix:

interface sl

1) externí aplikace (např. dohledový systém, SCADA, SIEM, nemocniční informační systém atd...)

2) externí část rozhraní - tuto část rozhraní vytváří aplikační partner, je pro ni generován InterfaceID

3) přenos dat

4) interní část rozhraní - tato část je prezentována tzv. typem rozhraní

5) systém Maatrix

 

Registrace a typy rozhraní

Systém Maatrix tvoříme tak, aby byl maximálně otevřený pro různé přenosové technologie a komunikační formáty. Námi používané nástroje nám umožňují téměř nemít hranice pro to, jakým způsobem si budeme předávat data. Typy rozhraní jsou tedy rozmanité – popisované technologie a formáty přenosu naleznete zde.

Externí část rozhraní musí být v systému Maatrix zaregistrována. Registrováním vznikne InterfaceID, které je pro komunikaci s Maatrixem nezbytné. Je možné použít univerzální veřejné registrace a nebo může vývojář své rozhraní pro externí aplikaci sám zaregistrovat. Registrace není žádný problém – budeme se jí věnovat v části popisující tvorbu externí části interface.

Důvody pro svoji registraci a řízení externího přístupu jsou především tyto:

1) bezpečnost systému – každý administrátor si u své služby může takto velmi jednoduše regulovat, které vstupy (resp. ze kterého rozhraní, ze které aplikace) může dojít ke spuštění služby

2) obchodní důvody – smlouvy s aplikačními partnery (tvůrci externích rozhraní) umožní odměňovat tvůrce rozhraní podle použití jimi vytvořených externích rozhraní

3) kvalita připojení – takto jsme schopni aplikačnímu partnerovi mnohem lépe a rychleji pomoci s vytvořením externí části rozhraní a zároveň hlídat případné chyby a reagovat na ně.

Postup registrace naleznete zde.

 

Universální vs. jednoúčelový

Maatrix je systém, ve kterém mohou vznikat prakticky libovolné komunikační postupy, které mohou vyžadovat prakticky libovolné vstupní parametry – vše závisí na tom, jakou šablonu si pro svoji službu vyberete. Rozhraní pro spouštění komunikačních služeb pak může být vytvořeno tak, že vstupní parametry jsou v rozhraní připraveny „napevno“, tj. takové rozhraní je možné použít pouze pro ty služby, které vycházejí ze šablon ze stejnými vstupními parametry. Rozhraní však může umožňovat variabilní nastavení parametrů a takové rozhraní je možné použít universálně pro více různých služeb.