1 Začínáme

SOAP API VOIPEX Platformy 7. generace vám umožnuje napojit vaše aplikace na naše elekomunikacní a billingové služby. Díky tomu mužete vytvorit vlastní administracní rozhraní a snadno rozšírit své informacní systémy, aplikace a další programové vybavení o  řadu funkcí, které API nabízí. Referencní aplikací je B2B portál, který využívá témer všechny  možnosti API. V soucasné dobe jsou implementovány pouze mobilní služby.

KROK 1: PRÍSTUPOVÉ UDAJE
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 pres HTTPS protokol a WSDL(popis služeb API) je dostupné na adrese https://api.ipex.cz/soap/ProviderManagement/v1/?wsdl
• Zde uvádené prí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.
• Prihlášení k API. Prihlašovací údaje zadejte na vstup metody getAccessToken, v odpovedi se vrátí accessToken nutný pro volání dalších metod. Token si nekam uložte napr. do session. Více informací o tokenu a autentizaci se doctete 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 zprístupní možnost volat další metody. Token se predává v hlavicce 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ý príklad je k dispozici mezi vzorovými príklady.

KROK 3: POKROCILÁ IMPLEMENTACE

• Proctete si dokumentaci jednotlivých metod a inspiraci hledejte mezi vzorovými príklady.
• V dokumentaci je v popisu parametru datový typ, který musí být dodržen, a to jestli je parametr povinný ci nepovinný. U nepovinného vstupního parametru to znamená, že nemusí být vyplnen a u výstupního že nemusí být obsažen v odpovedi.
• Pokud klient odešle chybný vstupní parametr je mu vracen 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.