Podstawowe informacje o API
Wstęp
Witamy w API SkinsBack.
Jeśli masz jakieś pytania lub sugestie, skontaktuj się z nami.
Interakcja z API SkinsBack odbywa się za pośrednictwem punktu końcowego https://skinsback.com/api.php, do którego dane muszą zostać przesłane za pośrednictwem żądań POST.
Uwierzytelnianie
Wszystkie żądania API wymagają uwierzytelnienia. Istnieją dwie opcje uwierzytelnienia do wyboru: za pośrednictwem nagłówków HTTP lub za pośrednictwem podpisu.
Uwierzytelnianie za pomocą nagłówków HTTP (łatwiejsze)
Konieczne jest przekazanie dwóch parametrów w nagłówkach żądania HTTP:
X-CLIENT-ID — wartość Client ID z ustawień projektu
X-CLIENT-SECRET — wartość Client Secret z ustawień projektu
Uwierzytelnianie za pomocą podpisu (bardziej złożone)
W przypadku korzystania ze starszej metody uwierzytelniania należy przekazać dwa parametry POST:
shopid — wartość identyfikatora klienta z ustawień projektu
sign — podpis wygenerowany zgodnie z zasadami opisanymi w sekcji Generowanie podpisu.
Struktura odpowiedzi
Wszystkie metody API mają odpowiedzi JSON.
Pomyślne wywołania API będą miały następującą odpowiedź:
{"status":"success", some data..}
Nieudane żądania będą zawierać kod błędu i komunikat o błędzie:
{"status":"error", "error_code": 5, "error_message":"some_error"}
Ograniczenie liczby żądań
Nasz system ma limit 500 żądań do serwera na minutę. Jeśli limit ten zostanie przekroczony, nastąpi tymczasowa blokada, a odpowiedź API będzie następująca:
{"status":"error", "error_code": -7, "error_message":"request_limit_reached"}