Zasoby

Publiczny REST API WareRushAI (tylko do odczytu)

Odczytuj swoje produkty, stany magazynowe, zamówienia, brakujące dane i błędy marketplace z poziomu Zapier, Make, n8n lub własnego kodu za pomocą klucza API. Zawiera specyfikację OpenAPI 3.1.

Revised:

1. Czym jest API

REST API WareRushAI pozwala zewnętrznym programom odczytywać dane jednej firmy: produkty, stany magazynowe w podziale na lokalizacje, zamówienia, produkty z brakującymi danymi oraz błędy ofert na marketplace'ach. W tej wersji działa wyłącznie w trybie do odczytu i opiera się na tych samych usługach oraz uprawnieniach, co aplikacja webowa i konektor MCP. Adres bazowy to https://app.warerushai.com/api/v1. API jest udostępniane stopniowo: dopóki nie zostanie włączone dla całej platformy, każde wywołanie zwraca kod 404 i nie można tworzyć kluczy.

2. Tworzenie klucza API

Właściciel lub administrator przechodzi do sekcji Ustawienia, następnie Integracje, potem Klucze API, nadaje kluczowi nazwę, wybiera uprawnienia (catalog.read, inventory.read, orders.read, account.read), datę ważności oraz limit minutowy, po czym go tworzy. Pełny klucz zaczyna się od wra_live_ i jest wyświetlany tylko raz. WareRushAI przechowuje wyłącznie jednostronny skrót (hash) oraz pierwsze znaki, dlatego utraconego klucza nie można odzyskać – należy wygenerować nowy. Klucz można w dowolnym momencie unieważnić lub dokonać jego rotacji: nowy klucz zostanie wyświetlony raz, a stary będzie działać jeszcze przez 24 godziny.

3. Uwierzytelnianie

Przesyłaj klucz w nagłówku Authorization: Authorization: Bearer wra_live_... przez protokół HTTPS. Nigdy nie umieszczaj klucza w adresie URL; żądanie zawierające klucz w adresie zostanie odrzucone z błędem key_in_url. Przykład: curl -H "Authorization: Bearer $WRA_KEY" "https://app.warerushai.com/api/v1/products?limit=20". Tokeny dostępowe OAuth 2.1 z konektora MCP są również akceptowane, w zakresie uprawnień zatwierdzonych przez użytkownika.

4. Punkty końcowe (Endpoints)

GET /me (informacje o kluczu, jego limitach i dzisiejszym zużyciu), GET /products (wyszukiwanie i lista, z parametrami query, limit, cursor), GET /products/{id}, GET /locations, GET /inventory (pozycje magazynowe, stronicowane), GET /inventory/summary, GET /orders (z parametrami updated_since, status, source, limit, cursor), GET /missing-data oraz GET /marketplace-errors (z parametrem channel). Każdy punkt końcowy wymaga odpowiedniego uprawnienia: catalog.read dla produktów, brakujących danych i błędów ofert, inventory.read dla lokalizacji i stanów magazynowych, orders.read dla zamówień. Obsługiwana jest wyłącznie metoda GET; inne metody zwracają błąd 405.

5. Stronicowanie i odpytywanie (polling)

Listy zwracają pola data, next_cursor oraz has_more, z maksymalnie 50 elementami na stronę (limit od 1 do 50, domyślnie 20). Przekaż wartość next_cursor jako parametr cursor, aby pobrać kolejną stronę. W przypadku wyzwalaczy cyklicznych (polling) w Zapier, Make i n8n wywołaj GET /orders?updated_since=2026-11-15T08:00:00Z i zapisz czas ostatniego udanego zapytania: otrzymasz zamówienia utworzone lub zmodyfikowane od tego momentu, począwszy od najnowszych.

6. Limity i błędy

Każdy klucz ma limit minutowy (domyślnie 60, maksymalnie 600) oraz opcjonalny limit dzienny. Każda firma posiada także dzienny przydział zależny od planu: domyślnie 1 000 wywołań w planie Starter, 10 000 w Business oraz 100 000 w Pro. Po osiągnięciu limitu API zwraca kod 429 z nagłówkiem Retry-After. Nagłówki X-RateLimit-Limit, X-RateLimit-Remaining, X-Daily-Limit oraz X-Daily-Remaining informują o pozostałej liczbie zapytań. Komunikaty błędów mają zawsze format {"error":{"code","message","request_id"}}; podaj request_id podczas kontaktu z pomocą techniczną. Typowe kody: invalid_api_key (401), insufficient_scope (403), not_found (404), invalid_parameter (400), rate_limited oraz daily_quota_exceeded (429).

7. Specyfikacja OpenAPI

Ustrukturyzowana specyfikacja OpenAPI 3.1 jest dostępna pod adresem https://app.warerushai.com/api/v1/openapi.json i nie wymaga klucza. Zaimportuj ją do Postman, Zapier, Make, n8n lub asystenta AI, aby uzyskać pełną listę punktów końcowych, parametrów i schematów odpowiedzi. Zmiany są wprowadzane w sposób zachowujący wsteczną kompatybilność istniejących pól; aktualna wersja to /api/v1.

8. Bezpieczeństwo

Klucze są przypisane do dokładnie jednej firmy i weryfikowane przy każdym wywołaniu. Klucz nigdy nie pozwala na odczyt danych innej firmy i przestaje działać, jeśli administrator, który go utworzył, opuści organizację. Klucze nigdy nie trafiają do logów ani komunikatów o błędach, a historia wywołań zawiera jedynie ścieżkę, status i czas. Dane finansowe, takie jak ceny zakupu, nie są udostępniane przez to API.