Przejdź do głównej zawartości

Beel API — przegląd

Beel API to emulator API BaseLinkera — jeden, scentralizowany adres w formacie BaseLinkera, w odróżnieniu od rozproszonego na wiele serwisów API natywnego (zobacz Wprowadzenie → Dwa API). Przyjmuje te same metody (getOrders, addOrder, getInventoryProductsData…), w tym samym formacie i zwraca odpowiedzi w tym samym kształcie. Jeśli masz już integrację z BaseLinkerem, często wystarczy podmienić adres i token.

POST https://{instancja}-beel-api.enterprise.sellrocket.pl/connector.php

Identyczny jak w BaseLinkerze — application/x-www-form-urlencoded z polami:

Pole Opis
method Nazwa metody, np. getOrders
parameters Parametry metody jako tekst JSON
Okno terminala
curl -X POST "https://{instancja}-beel-api.enterprise.sellrocket.pl/connector.php" \
-H "X-BLToken: $BEEL_TOKEN" \
--data-urlencode "method=getOrders" \
--data-urlencode 'parameters={"date_confirmed_from": 1727740800, "get_unconfirmed_orders": false}'
{
"status": "SUCCESS",
"orders": [
{ "order_id": 204295, "order_status_id": 1, "date_confirmed": 1727745123, "products": [ ... ] }
]
}

Beel API używa statycznego tokenu przypisanego do połączenia „Beel” w instancji (a nie tokenu JWT jak REST API). Token przekazujesz w nagłówku X-BLToken — tak jak w BaseLinkerze.

  1. W panelu Sellrocket przejdź do Integracje → Połączenia i wybierz Utwórz połączenie.
  2. Wyszukaj na liście integrację Beel i dodaj ją.
  3. Nadaj połączeniu nazwę, ustaw Token API (dowolny, trudny do odgadnięcia ciąg — możesz użyć dotychczasowego tokenu BaseLinkera), w polu Nazwa nagłówka wpisz X-BLToken i zaznacz Połączenie skonfigurowane.
  4. W swojej integracji podmień adres https://api.baselinker.com/connector.php na adres Beel API i użyj tego tokenu.

Zamiast nagłówka możesz przekazać token w polu token formularza — tak jak w starszych integracjach BaseLinkera.

Każdy token odpowiada jednemu połączeniu. Możesz utworzyć kilka połączeń Beel (np. osobne dla różnych systemów) — tokeny muszą być unikalne. Zamówienia dodane przez addOrder są przypisywane do połączenia, do którego należy token.

Tak jak w BaseLinkerze — odpowiedź HTTP ma zawsze kod 200, a o błędzie informuje treść:

{
"status": "ERROR",
"error_code": "ERROR_BAD_TOKEN",
"error_message": "Invalid user token"
}
Kod Znaczenie
ERROR_EMPTY_TOKEN / ERROR_BAD_TOKEN Brak tokenu lub token nieprzypisany do żadnego połączenia
ERROR_CONNECTOR_MISCONFIGURED W instancji nie ma skonfigurowanego połączenia Beel (z tokenem i nazwą nagłówka)
ERROR_UNKNOWN_METHOD Brak method lub metoda nieobsługiwana — zobacz listę metod
ERROR_PARSE_JSON_PARAMETERS Niepoprawny JSON w parameters
ERROR_BLOCKED_TOKEN Przekroczony limit zapytań — ponów po ok. minucie (zobacz Limity)
ERROR_BAD_ORDER_ID, ERROR_BAD_ORDER_STATUS_ID Nieistniejące zamówienie / status
ERROR_SAVING_ORDER addOrder — zamówienie starsze niż 2 miesiące
ERROR_BAD_STATUS_ID, ERROR_BAD_ORDER_ITEM_ID addOrderReturn — nieistniejący status zwrotu lub pozycji / pozycja spoza zamówienia
ERROR_BAD_TRIGGER_ID runOrderMacroTrigger — nieistniejące zdarzenie użytkownika
ERROR_PRODUCT_ID, ERROR_CATEGORY_ID, ERROR_STORAGE_ID, ERROR_MANUFACTURER_ID Nieistniejący produkt / kategoria / katalog / producent
ERROR_COURIER_CODE, ERROR_COURIER Nieobsługiwany kod kuriera / niepoprawne dane paczki dla kuriera
ERROR_BAD_ORDER_SOURCE, ERROR_CONNECTIONS_COUNT getOrders — filter_order_source_id bez filter_order_source / filtr źródła pasuje do kilku połączeń
ERROR_INVALID_DATA, ERROR_UNSUPPORTED Niepoprawne dane lub operacja nieobsługiwana
UNKNOWN Nieoczekiwany błąd — szczegóły w error_message
Emulator (Beel API) API natywne
Masz działającą integrację z BaseLinkerem Budujesz integrację od zera
Potrzebujesz zamówień, produktów, stanów, cen, przesyłek, podstawowej obsługi zwrotów Potrzebujesz pełni funkcji: statusy i refundacje zwrotów, pola elastyczne, automatyzacje, faktury, wydruki
Chcesz szybko uruchomić migrację Chcesz korzystać z operacji masowych i filtrowania

Oba można łączyć: Beel API dla istniejącej synchronizacji, API natywne dla nowych funkcji.

Wybierasz API natywne? Zacznij od Szybkiego startu, a odpowiedniki pojęć i metod BaseLinkera znajdziesz w słowniku „Z BaseLinkera do Sellrocket”.

Dalej: Obsługiwane metody · Różnice względem BaseLinkera · Identyfikatory z BaseLinkera — które ID (statusy, źródła, konta kurierskie, pola dodatkowe) da się zachować przy migracji