REST API VOIPEX Platformy 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 generována z kódu je umístěna na https://restapi-devel.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. Uživatele SOAP API mohou použít stávající údaje.
KROK 2: ZÁKLADNÍ IMPLEMENTACE
...
KROK 3: POKROČILÁ IMPLEMENTACE
- Pročtěte si dokumentaci jednotlivých metod a inspiraci hledejte mezi vzorovými příklady.
- V dokumentaci je v popisu parametru datový typ, který musí být dodržen, a to jestli je parametr povinný či nepovinný. U nepovinného vstupního parametru to znamená, že nemusí být vyplněn a u výstupního, že nemusí být obsažen v odpovědi.
- Pokud klient odešle chybný vstupní parametr, je mu vrácen chybový kód > 0 v parametru result a popis chyby v resultText, více naleznete v obecném popisu chyb a v dokumentaci jednotlivých metod.