Komunikacja z interfejsem API odbywa się wyłącznie przez HTTPS, czyli w sposób szyfrowany. Wszystkie żądania korzystają z metody GET.
Niektórym metodom można przekazywać parametry wejściowe – wstawia się je bezpośrednio do adresu URL żądania jako parametry GET.
URL i format odpowiedzi
Interfejs API jest dostępny pod adresem:
https://api.wedos.as/partner/{method_name}
Wszystkie metody zwracają odpowiedź w formacie JSON.
Częścią każdej odpowiedzi jest requestId, które jednoznacznie identyfikuje konkretne żądanie.
Wszystkie dane w odpowiedzi są kodowane w UTF-8.
Na podstawie requestId jesteśmy w stanie w razie problemu odnaleźć konkretną komunikację w wewnętrznych logach.
Uwierzytelnianie
Każde żądanie API musi być uwierzytelnione. Służy do tego klucz API, który działa podobnie jak hasło, ale jest przeznaczony wyłącznie do API.
Klucz API nie jest tożsamy z hasłem, którego używasz do logowania do administracji partnerskiej.
Klucz API generujesz po zalogowaniu do administracji partnerskiej w sekcji
Konto, ustawienia – Ustawienia API.
Nagłówki HTTP
Uwierzytelnianie odbywa się za pomocą dwóch nagłówków HTTP, które należy dodać do każdego żądania:
- X-Auth-Id – ID klucza API
- X-Auth-Key – sam klucz API
Przykład żądania HTTPS
Poniżej znajduje się przykład prostego żądania API wraz z niezbędnymi nagłówkami HTTP.
Jest to metoda ping, za pomocą której możesz sprawdzić, że komunikacja działa poprawnie.
GET /partner/ping HTTP/1.1 Host: api.wedos.as Accept: application/json X-Auth-Id: KEYID X-Auth-Key: YOURKEY
Przykładowa odpowiedź
Przy pomyślnym wywołaniu metody ping API zwraca ID partnera oraz bieżącą datę i godzinę:
{ "stamp": 1495544024, "time": "2017-05-23 14:53:44", "partnerId": 300000, "requestId": "1495544024.0084.8420" }
Odpowiedzi błędów
W przypadku błędu serwer zwraca kod HTTP inny niż 200 a w treści odpowiedzi podany jest kod błędu i jego opis.
Na przykład przy żądaniu z błędnym uwierzytelnianiem:
{ "error": { "code": "C507", "error": "Authentication failed" }, "requestId": "1495544185.1615.8422" }
Jeśli napotkasz problem z API lub potrzebujesz odnaleźć konkretne żądanie po requestId,
możesz napisać na
affiliate@wedos.com.