Dokumentacja

1. 1

   Utwórz konto

   Zarejestruj darmowe konto FeedPilot. Bez karty kredytowej.

2. 2

   Połącz sklep

   Połącz Shopify, WooCommerce lub własny sklep przez bezpieczne OAuth lub poświadczenia API.

3. 3

   Przejrzyj katalog

   FeedPilot importuje produkty i sygnalizuje problemy (brakujące atrybuty, niska jakość zdjęć itp.).

4. 4

   Skonfiguruj reguły cenowe

   Ustaw docelowe marże, uwzględnij prowizje marketplace i zdefiniuj strategie cenowe na kanał.

5. 5

   Publikuj i monitoruj

   Wyślij listingi na wybrane marketplace i śledź wyniki w dashboardzie.

Base URL i konwencje

Wszystkie endpointy żyją pod jednym base URL i przyjmują/zwracają wyłącznie JSON.

https://app.feedpilot.ai/api/v1/<resource>

• Każde żądanie musi zawierać Accept: application/json.
• Operacje zapisu wymagają Content-Type: application/json i body w formacie JSON.
• Daty w ISO 8601 (UTC). Pieniądze jako stringi dziesiętne (np. "39.90").
• Konta z wieloma sklepami: użyj ?store=<id> lub headera X-Store-Id: <id>; w przeciwnym razie używany jest pierwszy sklep z konta.

Uwierzytelnienie

Uwierzytelniaj się tokenem osobistym w nagłówku Authorization. Wygeneruj token w panelu admin: Settings → API tokens. Token pokazujemy raz przy tworzeniu — skopiuj go wtedy, bo trzymamy tylko hash.

Authorization: Bearer fpt_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Accept: application/json

Sprawdź token: GET /api/v1/me — zwraca zalogowanego usera, jego sklepy i listę uprawnień tokenu.

Uprawnienia (scopes)

Każdy token ma listę uprawnień. Każdy endpoint wymaga konkretnego — żądanie bez wystarczających uprawnień zwraca 403 Forbidden. * daje pełny dostęp — używaj tylko dla zaufanej automatyzacji.

Dostępne scopes: read:products, write:products, read:orders, read:inventory, write:inventory, read:feeds, write:feeds, read:channels, write:channels, read:returns, write:returns, read:payments, manage:webhooks, *.

Limit zapytań

Domyślnie: 60 zapytań/minutę na token. Każda odpowiedź zawiera nagłówki X-RateLimit-Limit i X-RateLimit-Remaining. Po przekroczeniu zwracamy 429 Too Many Requests z headerem Retry-After.

Paginacja i filtry

Wszystkie endpointy listujące są paginowane. Parametry: ?page=N&per_page=N (domyślnie 25, max 100). Odpowiedź zawiera data, meta i links. Każdy resource akceptuje swoje filtry przez query params.

Błędy

Wszystkie błędy zwracają JSON z polem message. Walidacja dodatkowo zawiera obiekt errors kluczowany po polach. Status codes: 400 (bad request), 401 (brak/zły token), 403 (brak uprawnień), 404 (nie znaleziono), 422 (walidacja), 429 (rate limit), 500 (serwer).

Resources

Pełna lista endpointów z parametrami i przykładami: wersja angielska. W skrócie:

• Products / Variants — pełny CRUD, filtry: status, search
• Orders — read-only (zamówienia spływają z marketplaces; subskrybuj webhook order.created)
• Stock items — list/show/update (zmienisz on_hand / reserved)
• Feeds — CRUD + akcja POST /feeds/{id}/sync
• Channel accounts & listings — CRUD + bulk POST /listings/generate
• Returns — list/show/update (akceptacja/odrzucenie/zwrot środków)
• Payments — read-only ledger (sprzedaż, zwroty, opłaty, payouts)
• Webhooks — pełny CRUD do subskrybowania eventów

Webhooki

Subskrybuj endpoint HTTPS, żeby otrzymywać powiadomienia o eventach. Każdy event to POST z body JSON podpisanym HMAC-SHA256. Nieudane dostarczenia powtarzamy 3× (1 min, 5 min, 30 min); po 10 kolejnych porażkach endpoint jest auto-wyłączany.

Eventy: order.created, order.updated, order.shipped, order.refunded, inventory.updated, return.requested, return.decided, payment.received, message.received, feed.synced, listing.created, listing.updated.

Header podpisu: X-FeedPilot-Signature: sha256=<hex>. Weryfikuj zawsze na surowym body żądania (nie na sparsowanym JSON), używając hash_hmac('sha256', $rawBody, $secret).

Przykłady kodu

Lista produktów — curl

curl -s https://app.feedpilot.ai/api/v1/products?per_page=10 \
  -H "Authorization: Bearer $FEEDPILOT_TOKEN" \
  -H "Accept: application/json"

Tworzenie produktu — JavaScript (fetch)

const res = await fetch(
  "https://app.feedpilot.ai/api/v1/products",
  {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${process.env.FEEDPILOT_TOKEN}`,
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({
      name: "Sage rinse cup · Mint",
      sku: "HP-045",
      price: "39.90",
      status: "active",
    }),
  },
);
const { data } = await res.json();
console.log(data.id);

Aktualizacja stanu — PHP (Guzzle)

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://app.feedpilot.ai/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('FEEDPILOT_TOKEN'),
        'Accept' => 'application/json',
    ],
]);

$response = $client->put("stock-items/$stockItemId", [
    'json' => ['on_hand' => 47],
]);

$data = json_decode($response->getBody(), true)['data'];
echo $data['available'];

Wersjonowanie

Aktualna wersja: v1. Breaking changes wprowadzamy pod nowym prefixem (np. /api/v2/). Zobowiązujemy się utrzymać v1 przez minimum 12 miesięcy po wydaniu v2, z poprawkami bezpieczeństwa później. Pełna referencja endpointów po angielsku: feedpilot.ai/docs/#api.