Komunikace s API rozhraním probíhá výhradně přes HTTPS, tedy šifrovaně. Pro všechny požadavky se používá metoda GET.
Některým metodám lze předávat vstupní parametry – ty se vkládají přímo do URL adresy požadavku jako GET parametry.
URL a formát odpovědi
API rozhraní je dostupné na adrese:
https://api.wedos.as/partner/{nazev_metody}
Všechny metody vrací odpověď ve formátu JSON.
Součástí každé odpovědi je requestId, který jednoznačně identifikuje konkrétní požadavek.
Veškerá data v odpovědi jsou kódována v UTF-8.
Podle requestId jsme schopni v případě problému dohledat konkrétní komunikaci v interních logách.
Autentizace
Každý API požadavek musí být autentizovaný. K tomu slouží API klíč, který funguje obdobně jako heslo, ale je určen výhradně pro API.
API klíč není totožný s heslem, které používáš pro přihlášení do partnerské administrace.
API klíč si vygeneruješ po přihlášení do partnerské administrace v sekci
Účet, nastavení – Nastavení API.
HTTP hlavičky
Autentizace probíhá pomocí dvou HTTP hlaviček, které je nutné přidat ke každému požadavku:
- X-Auth-Id – ID API klíče
- X-Auth-Key – samotný API klíč
Příklad HTTPS požadavku
Níže je ukázka jednoduchého API požadavku včetně potřebných HTTP hlaviček.
Jedná se o metodu ping, kterou si můžeš ověřit, že komunikace funguje správně.
GET /partner/ping HTTP/1.1 Host: api.wedos.as Accept: application/json X-Auth-Id: IDKLICE X-Auth-Key: VASKLIC
Příklad odpovědi
Při úspěšném volání metody ping API vrátí ID partnera a aktuální datum a čas:
{ "stamp": 1495544024, "time": "2017-05-23 14:53:44", "partnerId": 300000, "requestId": "1495544024.0084.8420" }
Chybové odpovědi
V případě chyby vrací server HTTP kód jiný než 200 a v těle odpovědi je uveden kód chyby a její popis.
Například při požadavku s chybnou autentizací:
{ "error": { "code": "C507", "error": "Authentication failed" }, "requestId": "1495544185.1615.8422" }
Pokud narazíš na problém s API nebo potřebuješ dohledat konkrétní požadavek podle requestId,
můžeš napsat na
affiliate@wedos.com.