Komunikácia s rozhraním API prebieha výlučne prostredníctvom HTTPS, t. j. šifrovaná. Pre všetky požiadavky sa používa metóda GET.
Niektorým metódam je možné odovzdať vstupné parametre – tieto sa vkladajú priamo do adresy URL požiadavky ako parametre GET.
URL a formát odpovede
Rozhranie API je dostupné na adrese:
https://api.wedos.as/partner/{nazev_metody}
Všetky metódy vracajú odpoveď vo formáte JSON.
Každá odpoveď obsahuje requestId, ktorý jednoznačne identifikuje konkrétnu požiadavku.
Všetky údaje v odpovedi sú kódované v UTF-8.
Na základe requestId sme schopní v prípade problému vysledovať konkrétnu komunikáciu vo vnútorných protokoloch.
Overenie
Každá požiadavka API musí byť overená. To sa vykonáva pomocou kľúča API, ktorý funguje podobne ako heslo, ale je určený výlučne pre API.
Kľúč API nie je rovnaký ako heslo, ktoré používate na prihlásenie sa do administrácie partnera.
API kľúč si môžete vygenerovať po prihlásení sa do sekcie správy partnerov na stránke
Účet, nastavenia – Nastavenia API.
HTTP hlavičky
Overenie sa vykonáva pomocou dvoch hlavičiek HTTP, ktoré musia byť pridané ku každej požiadavke:
- X-Auth-Id – ID kľúča API
- X-Auth-Key – samotný kľúč API
Príklad požiadavky HTTPS
Nižšie je uvedený príklad jednoduchého požiadavku API vrátane potrebného HTTP headers.
Ide o metódu ping, ktorú môžete použiť na overenie správneho fungovania komunikácie.
ZÍSKAJTE /partner/ping HTTP/1.1 Host: api.wedos.as Prijímať: application/json X-Auth-Id: IDKLICE X-Auth-Key: VASKLIC
Príklad odpovede
Keď je metóda ping úspešne volaná, API vráti ID partnera a aktuálny dátum a čas:
{ "stamp": 1495544024, "time": "2017-05-23 14:53:44", "partnerId": 300000, "requestId": "1495544024.0084.8420" }
Nesprávne odpovede
V prípade chyby server vráti HTTP kód iný ako 200 a kód chyby a jej popis sú zahrnuté v tele odpovede.
Napríklad v prípade požiadavky s nesprávnym overením:
{ "error": { "code": "C507", "error": "Authentication failed" }, "requestId": "1495544185.1615.8422" }
Ak narazíte na problém s API alebo potrebujete vyhľadať konkrétnu požiadavku podľa requestId,
môžete napísať na
affiliate@wedos.com.