Jak použít API

Nastavení rozhraní - administrátor komunikační služby v systému Maatrix

Tato část je určena pro administrátory systému Maatrix. Musí být tedy splněny následující předpoklady:

1) Jste uživatelem systému Maatrix (www.in-maatrix.com)

2) V systému Maatrix je založen zákazník a u něj komunikační služba, ke které jste definován jako administrátor služby

 

Službu systému Maatrix je možné v závislosti na zvolené šabloně spustit trojím způsobem:

I) za pomoci webového přístupu na systém Maatrix, kterému říkáme Panel systému

II) za pomoci Zkráceného webového přístupu (tzv. ShortCall), tj. pro volání služby je vygenerována speciální web adresa, která slouží přímo pro spuštění konkrétní služby

III) za pomoci Rozhraní pro volání služby (callAPI), pomocí kterého mohou službu spouštět a získávat zpět výsledky služby externí aplikace.

 

V této části se věnujeme právě třetí variantě, tj. chcete pro spouštění služby používat za pomoci callAPI externí aplikaci. 

 

Aby bylo možné takové propojení realizovat, musí být splněny následující předpoklady:

a) Externí aplikace, kterou chcete propojit, musí propojení na Maatrix podporovat (tj. musí mít v sobě zabudován interface na systém Maatrix). Tuto informaci zjistíte od dodavatele této aplikace

b) Externí aplikace musí být nainstalována / nastavena tak, aby mohla spouštět Vaše konkrétní komunikační služby. Toto nastavení by měl provést správce této aplikace (popis naleznete zde)

 

Nastavení připojení externí aplikace provedete v Nastavení služby:

1. Přihlásíte se do systému Maatrix (www.in-maatrix.com)

2. Přejdete do části Portál

3. V levém menu zvolíte Setup - Nastavení a vyberete komunikační službu, pro kterou chcete externí aplikaci připojit

4. V záložce Interfaces - Rozhraní (1) nastavíte potřebné údaje:

     a. V části Rozhraní pro volání služby (zarámováno) vyberete rozhraní připojované externí aplikace. Pro toto rozhraní máte možnost definovat, jestli je a nebo není služba dostupná (tj. jestli může být tímto rozhraním volána vybraná služba) - (2)

     b. Systém automaticky generuje M2M heslo, kterým se ověřuje propojení. Máte možnost toto M2M heslo kdykoli vygenerovat nové (4) - nově vygenerované heslo je pak ale následně potřeba nastavit i v externí aplikaci.*

     c. Máte možnost omezit adresy, ze kterých jsou přijímány systémem Maatrix zprávy z vybraného rozhraní pro nastavovanou komunikační službu *. Např. pokud komunikace probíhá na protokolu smtp tak můžete omezit zdroj volání konkrétní mailovou adresou a nebo doménou, pokud komunikace probíhá na protokolu http tak je možné definovat IP adresu, za které smí dojít k volání atd.

     d. Pokud to umožňuje použitá šablona služby je možné nastavit k jedné službě i více rozhraní, tj. jedna komunikační služba může být spuštěna z více externích systémů.

     e. Ke vybrané službě a vybranému rozhraní zjistíte podrobnosti u informační klávesy (5)

 

set interface

 

*) Toto nastavení je možné v závislosti na použité šabloně, ze které vznikla konkrétní komunikační služba. Více zjistíte v informaci u konkrétní služby

info template