Komunikácia s API rozhraním prebieha výhradne cez HTTPS, teda šifrovane. Pre všetky požiadavky sa používa metóda GET.
Niektorým metódam možno odovzdávať vstupné parametre – tie sa vkladajú priamo do URL adresy požiadavky ako GET parametre.
URL a formát odpovede
API rozhranie je dostupné na adrese:
https://api.wedos.as/partner/{method_name}
Všetky metódy vracajú odpoveď vo formáte JSON.
Súčasťou každej odpovede je requestId, ktoré jednoznačne identifikuje konkrétnu požiadavku.
Všetky dáta v odpovedi sú kódované v UTF-8.
Podľa requestId sme schopní v prípade problému dohľadať konkrétnu komunikáciu v interných logoch.
Autentizácia
Každá API požiadavka musí byť autentizovaná. Na to slúži API kľúč, ktorý funguje obdobne ako heslo, ale je určený výhradne pre API.
API kľúč nie je totožný s heslom, ktoré používate na prihlásenie do partnerskej administrácie.
API kľúč si vygenerujete po prihlásení do partnerskej administrácie v sekcii
Účet, nastavenia – Nastavenia API.
HTTP hlavičky
Autentizácia prebieha pomocou dvoch HTTP hlavičiek, ktoré je nutné pridať ku každej požiadavke:
- X-Auth-Id – ID API kľúča
- X-Auth-Key – samotný API kľúč
Príklad HTTPS požiadavky
Nižšie je ukážka jednoduchej API požiadavky vrátane potrebných HTTP hlavičiek.
Ide o metódu ping, ktorou si môžete overiť, že komunikácia funguje správne.
GET /partner/ping HTTP/1.1 Host: api.wedos.as Accept: application/json X-Auth-Id: KEYID X-Auth-Key: YOURKEY
Príklad odpovede
Pri úspešnom volaní metódy ping 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" }
Chybové odpovede
V prípade chyby vracia server HTTP kód iný než 200 a v tele odpovede je uvedený kód chyby a jej popis.
Napríklad pri požiadavke s chybnou autentizáciou:
{ "error": { "code": "C507", "error": "Authentication failed" }, "requestId": "1495544185.1615.8422" }
Ak narazíte na problém s API alebo potrebujete dohľadať konkrétnu požiadavku podľa requestId,
môžete napísať na
affiliate@wedos.com.