Publiczne API

Przegląd publicznego API – co potrafi, jak się uwierzytelniać i jakie obowiązują limity.

1. Zakres użycia API

a. Funkcje obsługiwane przez API

Publiczne API umożliwia korzystanie z głównych funkcji aplikacji Wholesale, w tym:

Funkcje podstawowe: Wholesale Pricing, Volume Pricing, Registration form, Quick Order Form, Quick Buy Collection, Quick Buy Variant
Funkcje dodatkowe: Order Limit, Shipping Rate, Extra Fee, Payment Term (wkrótce)

b. Obsługiwane metody

API obsługuje pełny zestaw operacji CRUD za pomocą następujących metod HTTP:

GET – pobieranie danych
POST – tworzenie nowych danych
PUT – aktualizowanie istniejących danych
DELETE – usuwanie danych

Kluczom API można przyznać następujące poziomy uprawnień: Read Only/Write Only, Read & Write

Obsługiwane akcje: Get list - Get item - Create item - Update item - Delete item

c. Obsługiwane plany Shopify:

Publiczne API aplikacji Wholesale jest dostępne dla sklepów Shopify, które spełniają następujące wymagania:

Muszą być sklepami produkcyjnymi (nie dotyczy sklepów deweloperskich ani testowych)
Muszą mieć wykupiony plan Gold

2. Uwierzytelnianie

Wszystkie żądania API muszą zostać prawidłowo uwierzytelnione przed przetworzeniem.

a. Wymagane parametry

Każde żądanie API musi zawierać następujące obowiązkowe parametry:

Parametr	Opis
`shop`	Domena sklepu Shopify (np. mystore.myshopify.com)
`api_key`	Klucz API wygenerowany w aplikacji Wholesale

Jeśli brakuje któregokolwiek z tych parametrów, żądanie zostanie odrzucone.

b. Zarządzanie kluczami API

Klucze API tworzy się i zarządza się nimi bezpośrednio w panelu administracyjnym aplikacji Wholesale.
Właściciele sklepów mogą skonfigurować określone uprawnienia dla każdego klucza API: Read only/Write only, Read & Write

3. Struktura API i format odpowiedzi

a. Endpoint API

Wszystkie żądania API powinny używać następującego bazowego adresu URL:

https://wholesale.samita.io/v1/

b. Endpointy dla poszczególnych funkcji

Każda grupa funkcji ma własny endpoint. Na przykład:

Funkcja Wholesale:

https://wholesale.samita.io/v1/wholesale/

Funkcja Volume Pricing:
```
https://wholesale.samita.io/v1/volume/
```

(Faktyczne endpointy mogą się różnić w zależności od konkretnej funkcji).

c. Obsługiwane parametry zapytania

API obsługuje kilka typowych parametrów zapytania:

Parametr	Opis
`status`	Status rekordów
`page`	Numer strony do paginacji
`limit`	Liczba rekordów na stronę
`sort`	Kryteria sortowania
`query`	Warunek wyszukiwania lub filtrowania

Przykładowe żądanie:

GET /wholesale?page=1&limit=20&sort=created_at

4. Kody odpowiedzi

Każde żądanie API zwraca jeden z poniższych kodów statusu:

a. Typowe odpowiedzi z błędem

401 – Unauthorized

Możliwe przyczyny:

Brak adresu URL sklepu
Brak klucza API
Nieprawidłowy adres URL sklepu
Nieprawidłowy klucz API
Klucz API nie pasuje do sklepu

403 – This action is unauthorized

Klucz API nie ma uprawnień do wykonania żądanej akcji
Niewystarczające uprawnienia View / Create / Update / Delete

429 – Too Many Requests

Przekroczono limit żądań
Częstotliwość wywołań API przekracza dozwolony limit

b. Odpowiedź w przypadku powodzenia

200 – Success

Żądanie jest prawidłowe
Akcja API została wykonana pomyślnie
Dane są zwracane w prawidłowym formacie

5. Limit żądań

Aby zapewnić wydajność i stabilność systemu, korzystanie z API podlega dziennemu limitowi żądań. Nie ma już ograniczenia na pojedyncze żądania ani krótkie odstępy czasu – możesz wywoływać API tak często, jak potrzeba, o ile mieścisz się w dziennym limicie swojego planu.

Dzienny limit zależy od planu cenowego sklepu:

Plan	Dzienny limit żądań
Free	5 żądań dziennie
Starter	50 żądań dziennie
Growth	250 żądań dziennie
Enterprise	500 żądań dziennie

Dzienny licznik jest zerowany codziennie o północy (czas serwera).

Po przekroczeniu dziennego limitu system zwróci:

429 – Too Many Requests

{
  "message": "Daily request limit exceeded (X requests/day)."
}

Czy to było pomocne?