1 Začínáme

Owned by Martin Olexik (Unlicensed)
Last updated: bře 01, 2016

SOAP API VOIPEX Platformy 7. generace vám umožňuje napojit vaše aplikace na naše telekomunikační a billingové služby. Díky tomu můžete vytvořit vlastní administrační rozhraní a snadno rozšířit své informační systémy, aplikace a další programové vybavení o řadu funkcí, které API nabízí. Referenční aplikací je B2B portál, který využívá téměr všechny možnosti API. V současné době jsou implementovány pouze mobilní služby.

KROK 1: PRÍSTUPOVÉ ÚDAJE
Musíte získat prístupové údaje k API. Tyto údaje získáte od vašeho obchodníka.

KROK 2: ZÁKLADNÍ IMPLEMENTACE

  • Celá komunikace s API probíha přes HTTPS protokol a WSDL (popis služeb API) je dostupné na adrese https://api.ipex.cz/soap/ProviderManagement/v1/?wsdl
  • Zde uváděné příklady jsou psány v PHP a pokud narazíte behem implementace na nejaké problémy, zkuste si projít Poznámky SOAP klienta v PHP.
  • Přihlášení k API. Přihlašovací údaje zadejte na vstup metody getAccessToken, v odpovědi se vrátí accessToken nutný pro volání dalších metod. Token si uložte např. do session. Více informací o tokenu a autentizaci se dočtete zde.

    $wsdl = 'https://api.ipex.cz/soap/ProviderManagement/v1?wsdl';
    $soapClient = new SoapClient($wsdl, array('encoding' => 'UTF-8', 'trace' => 1,
    'exceptions' => 1));

    // ziskani overovaciho tokenu
    $credentials = array(
        'userName' => 'prihlasovaci jmeno',
        'password' => 'heslo'
    );

    $out = $soapClient->__soapCall("getAccessToken", $credentials);
    $accessToken = $out['accessToken'];

  • Po získání tokenu se vám zpřístupní možnost volat další metody. Token se předává v hlavičce SOAP požadavku:

    $wsdl = 'https://api.ipex.cz/soap/ProviderManagement/v1?wsdl';
    $soapClient = new SoapClient($wsdl, array('encoding' => 'UTF-8', 'trace' => 1,
    'exceptions' => 1));

    $tokenHeader = new StdClass;
    $tokenHeader->accessToken = $accessToken;
    $soapClient->__setSoapHeaders(new SoapHeader('urn:apiipex:
    providermanagement', 'verifyAccess', $tokenHeader));

    // provedeni dotazu
    $params = array(
    );
    $reponse = $soapClient->__soapCall("getAccessRights", $params);

  • Celý příklad je k dispozici mezi vzorovými příklady.

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.