Platforma Postman
Přihlaste se jako uživatel na adrese https://webcom.ipex.cz nebo do aplikace komunikátoru
https://ipexas.atlassian.net/wiki/spaces/VD/pages/289964079 .
Aplikaci komunikátor budeme vzdáleně ovládat a vytvářet odchozí a příchozí hovory.
API je postaveno na standardu GraphQL - https://graphql.org/ .
Pro ukázku ovládání použijeme SW třetí strany Postman, který je pro práci s API vhodný.
Aplikaci si stáhnete https://www.postman.com/downloads/ .
Zde si poté vytvoříte účet.
Po vytvoření účtu se přihlásíte do aplikace Postman (bez toho v současné době bohužel nelze jinak veřejně vystavené API importovat).
Volaní API je připraveno v tzv. Collections.
IPEX má Collections vystavené veřejně na adrese:
Ke Collections se také dostanete přes úvodní stránku, kde nahoře do vyhledávání zadáte ipexas a přejdete na úvodní stránku ipexas.
Teď je potřeba, abyste si Collections stáhli do svého Workplace.
V první řadě si stáhněte místo, kde poté zadáte přihlašovací údaje.
Tedy v levém sloupci nejdříve kliknete na Environments. Na řádku Production kliknete na 3 tečky a otevře se vám nabídka, kde vyberete Create a fork.
Aby se celé prostředí zkopírovalo na váš Workplace, je potřeba vyplnit název a prostředí. Poté vše potvrdíte tlačítkem Fork Environment.
Nyní si stáhneme Collections opět z našeho účtu ipexas.
Přepnout se do účtu ipexas můžete dle obrázku v nabídce rozkliknutím Workspaces a vyberete IPEX.
Jakmile se dostaneme do účtu Ipex vybereme v levém sloupci z nabídky Collections, poté na řádku Authentication kliknete opět na 3 tečky a vyberete Creat a fork. Poté postupujete jako v předchozím kroku, tady vyplníte název přidáte místo a potvrdíte stáhnutím do svého Workplace.
Poslední prostředí, které si stáhnete do svého Workplace bude RCC commands. Opět se přepnete do prostředí Ipex, kde si vyberete ze sloupce Collections, na řádku RCC commands 3 tečky a opět z nabídky Create a fork. Vyplníme název, vybereme prostředí a potvrdíme.
Jakmile budeme mít vše stažené na vlastní prostředí, ukážeme si přihlášení, získaní tokenu, vytvoření odchozího a příchozího hovoru.
Přihlášení:
V pravém sloupci si v nabídce vybereme Environments -> Production. Zobrazí se vám řádky pro vyplnění údajů. Vyplníte pouze řádky, které jsou označené. Jak vytvořit API přístup naleznete zde .
V pravém horním rohu poté uložíte zadané údaje a vyberete prostředí Production.
Než získáme tokeny, zkontrolujte, zda uživatel má nastavené API komunikátoru (RCC) v nastavení uživatele .
Jedná se o vyznačený údaj níže.
Získání Tokenů:
V levém sloupci si vybereme Collections, rozklikneme Authentication -> Token Exchange a vybereme Authenticate API access. Jakmile se dostaneme k tomuto přístupu, stisknete tlačítko send a tím získáte systémový token.
Nyní to stejné provedeme pro získání tokenu konkrétního uživatele. Tedy opět vybereme v levém sloupci Collection -> Token exchange a klikneme na podřazený řádek Token exchange. Zase odešleme tlačítkem send.
Odchozí hovor:
Nyní vytvoříme hovor. Přejdete v nabídce do Collections -> RCC commands -> Make call. Je potřeba, abyste byli v sekci Body. Vpravo u number zadáte volané číslo. Zkontrolujte si, zda máte přihlášený komunikátor a poté nahoře vpravo stisknete na tlačítko Send. Nyní můžete vidět odchozí hovor v komunikátoru.
Příklady kódů pro různé jazyky je možné zobrazit v pravém menu.
Ukázka události o hovoru:
Opět si stáhneme z prostředí Ipexas další Collections. Vyberete na řádku RCC events 3 tečky a potvrdíte Create a fork. Vyplníte název, prostředí a stáhneme Collections do Workplace.
V dalším kroku je třeba připojit websocket. Tedy opět v levém sloupci vybereme Collections -> RCC events a v tomto kroku kliknete na řádek Call events. Zkontrolujte, zda jste v sekci Params a poté v pravém okně stiskněte tlačítko Connect.
Vybereme Initial message a potvrdíme websocket přihlášením pomocí tlačítka Send.
Poslední krok pro posílaní události je poslat žádost o „Subscription“, tedy označit řádek Start listening to call events a stisknout tlačítko Send.
Nyní si můžete zkusit zavolat na přihlášený komunikátor a uvidíte číslo volajícího.
Příchozí hovor zvednete tlačítkem Send v RCC commands -> Answer call. Níže pak můžete vidět, že byl hovor úspěšně přijat.