Podstawy komunikacji, uwierzytelnianie

Komunikacja z interfejsem API odbywa się wyłącznie za pośrednictwem protokołu HTTPS, czyli w formie zaszyfrowanej. Do wszystkich żądań stosowana jest metoda GET.
Niektóre metody mogą przyjmować parametry wejściowe – są one umieszczane bezpośrednio w adresie URL żądania jako parametry GET.

Wszystkie metody zwracają JSON, a część każdej odpowiedzi stanowi requestId służący do wyszukiwania komunikacji w wewnętrznych logach.

URL i format odpowiedzi

Interfejs API jest dostępny pod adresem:

https://api.wedos.as/partner/{nazev_metody}

JSON

Wszystkie metody zwracają odpowiedź w formacie JSON.
Częścią każdej odpowiedzi jest requestId, który jednoznacznie identyfikuje konkretne żądanie.

UTF-8

Wszystkie dane w odpowiedzi są zakodowane w formacie UTF-8.

Na podstawie identyfikatora żądania (requestId ) jesteśmy w stanie w razie problemów 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 dla API.
Klucz API nie jest tożsamy z hasłem, którego używasz do logowania się do administracji partnerskiej.

Gdzie można otrzymać klucz

Klucz API można wygenerować po zalogowaniu się do panelu administracyjnego partnera 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 – identyfikator 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żna sprawdzić, czy komunikacja działa prawidłowo.

GET /partner/ping HTTP/1.1
Host: api.wedos.as
Accept: application/json
X-Auth-Id: IDKLICE
X-Auth-Key: VASKLIC

Przykładowa odpowiedź

W przypadku pomyślnego wywołania metody ping API zwraca identyfikator partnera oraz aktualną datę i godzinę:

{
  "stamp": 1495544024,
  "time": "2017-05-23 14:53:44",
  "partnerId": 300000,
  "requestId": "1495544024.0084.8420"
}

Błędne odpowiedzi

W przypadku błędu serwer HTTP zwraca kod inny niż 200, a w treści odpowiedzi podaje kod błędu i jego opis.
Na przykład w przypadku żądania z błędną autoryzacją:

{
  "error": {
    "code": "C507",
    "error": "Authentication failed"
  },
  "requestId": "1495544185.1615.8422"
}

Wskazówka:
Jeśli napotkasz problem z API lub potrzebujesz znaleźć konkretne żądanie według requestId,
możesz napisać na adres
affiliate@wedos.com.