1 Začínáme s REST API

POZOR: API pro firemní funkcionalitu (PBX, Call Centrum, UC, ..) je k dispozici v sekci Integrace s ERP/CRM systémy

REST API Operátorské platformy VOIPEX ISP 8. generace umožňuje napojit vaše aplikace na všechny námi nabízené telekomunikační a billingové služby. Díky tomu můžete využívat data z našich služeb ve vašich administračních portálech, CRM a ERP. Referenční aplikací využívající většinu funkcí API je B2B portál, který naleznete na https://b2b.ipex.cz/.

Dokumentace REST API generována z kódu je umístěna na https://restapi.ipex.cz/documentation.

Dokumentace je rozdělena na logické celky dle služeb.

Pro napojení na REST API postupujte dle následujících kroků:

KROK 1: PRÍSTUPOVÉ ÚDAJE
Přístupové údaje získáte od vašeho obchodníka.

KROK 2: ZÍSKÁNÍ PŘÍSTUPOVÉHO TOKENU

Celá komunikace s API probíhá přes HTTPS protokol. Volání jednotlivých funkcí je popsáno včetně parametrů a návratových hodnot v dokumentaci.

Příklad volání metody pro získání tokenu:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
  "username": "name",
  "password": "pass"
}' 'https://restapi.ipex.cz/v1/token'

Příklad návratové hodnoty ve formátu JSON po volání tokenu:

{
  "accessToken": "f911b1569cb327bb7ee5fed84ea9a29f",
  "expire": "2017-01-04T17:12:13.132Z" 
}

Příklad pro volání metody na získání tokenu lze otestovat přímo v dokumentaci.

KROK 3: PŘÍKLAD VOLÁNÍ DALŠÍCH FUNKCÍ

Příklad volání metody pro získání seznamu zákazníků:

curl -X GET --header 'Accept: application/json' -H 'Authorization: f911b1569cb327bb7ee5fed84ea9a29f' 'https://restapi.ipex.cz/v1/customers'

U všech volání (kromě dotazu na token) je potřeba v hlavičce Authorization uvést hodnotu tokenu.