Przejdź do głównej zawartości

Wprowadzenie

Sellrocket to system do obsługi sprzedaży wielokanałowej: zbiera zamówienia ze sklepów i marketplace’ów, prowadzi je przez proces realizacji (statusy, pakowanie, przesyłki, faktury, zwroty) i zarządza katalogiem produktów ze stanami i cenami. Jeśli pracowałeś z BaseLinkerem — idea jest ta sama.

Ta dokumentacja pozwala ocenić, czy i jak zbudujesz swoje rozwiązanie na Sellrocket, jeszcze zanim otrzymasz własną instancję.

Sellrocket udostępnia dwa API. Zanim zaczniesz, wybierz, z którego korzystasz — od tego zależy adres, token, format wywołań i część dokumentacji, której szukasz.

API natywne Emulator API BaseLinkera (Beel API)
Czym jest API Sellrocket — pełny dostęp do funkcji systemu Warstwa zgodności z API BaseLinkera: te same metody, format i odpowiedzi
Budowa Rozproszone — wiele serwisów, każdy z własnym adresem i własną referencją Scentralizowane — jeden adres dla wszystkich metod
Adres https://{instancja}-<serwis>.enterprise.sellrocket.pl — np. …-smerp-api… (zamówienia), …-pim-api… (produkty) https://{instancja}-beel-api.enterprise.sellrocket.pl/connector.php
Styl REST + JSON: zasoby, metody HTTP (GET/POST/PUT/DELETE), kody odpowiedzi HTTP, wersje w ścieżce (/api/v3/…) jak BaseLinker: zawsze POST, pola method i parameters (JSON), HTTP 200 także przy błędzie (status: "ERROR")
Token token API użytkownika (JWT) w nagłówku Authorization: Bearer … — ten sam we wszystkich serwisach (Uwierzytelnianie) token połączenia „Beel” w nagłówku X-BLToken (albo w polu token) — Beel API → Uwierzytelnianie
Zakres wszystkie funkcje dla integratorów: zamówienia, statusy, produkty (PIM), stany i ceny, przesyłki, zwroty, pola dodatkowe, automatyzacje, wydruki, importy, oferty… metody BaseLinkera, które Sellrocket obsługuje — Obsługiwane metody
Dokumentacja Przewodniki, Referencja API (osobna dla każdego serwisu), Swagger UI instancji Beel API: przegląd, obsługiwane metody, różnice, identyfikatory z BaseLinkera

Każdy klient Sellrocket dostaje własną instancję — odizolowane środowisko z osobną bazą danych. Instancja ma nazwę (otrzymasz ją przy uruchomieniu), która jest częścią adresu każdego serwisu:

https://{instancja}-{serwis}.enterprise.sellrocket.pl

API natywne jest rozproszone: każdy obszar systemu to osobny serwis z własnym adresem, własną wersją i własną referencją. Najczęściej używane:

Serwis Host Do czego
OMS {instancja}-smerp-api zamówienia, statusy, płatności, przesyłki, zwroty, połączenia, użytkownicy
PIM {instancja}-pim-api produkty, katalogi, kategorie, magazyny, stany, ceny, pola dodatkowe produktów
Pola elastyczne {instancja}-additional-fields-api pola dodatkowe zamówień, pozycji i zwrotów
Automatyzacje {instancja}-ajs-api skrypty automatyczne, w tym wystawianie faktur

Pełna lista: Przegląd serwisów. Jeden token działa we wszystkich serwisach tej samej instancji — zmienia się tylko adres. Integracja korzystająca z kilku obszarów (np. zamówienia + produkty) wywołuje kilka serwisów.

Beel API jest scentralizowane: wszystkie metody idą pod jeden adres {instancja}-beel-api…/connector.php, w formacie BaseLinkera. Pod spodem Beel API tłumaczy wywołania na API natywne — np. getOrders czyta zamówienia z OMS, getInventoryProductsData produkty z PIM.

  • Po co: integrację napisaną dla BaseLinkera przenosisz, zmieniając adres i token — bez przepisywania kodu.
  • Token: w panelu Sellrocket → Integracje → Połączenia → połączenie Beel: token API i nazwa nagłówka X-BLToken. Token przekazujesz w nagłówku X-BLToken (albo w polu token), tak jak w BaseLinkerze. Token Beel API nie działa w API natywnym i odwrotnie.
  • Ograniczenia: nie wszystkie metody BaseLinkera są obsługiwane, część działa z różnicami, a niektóre identyfikatory różnią się od BaseLinkera — przed migracją sprawdź Obsługiwane metody, Różnice i Identyfikatory z BaseLinkera.
Wybierz emulator (Beel API), gdy… Wybierz API natywne, gdy…
masz działającą integrację z BaseLinkerem i chcesz ją szybko przenieść budujesz integrację od zera
wystarczają Ci zamówienia, produkty, stany, ceny, przesyłki, podstawowe zwroty potrzebujesz pełni funkcji: statusy i refundacje zwrotów, pola dodatkowe, automatyzacje, faktury, wydruki
chcesz korzystać z operacji masowych, filtrowania i zadań asynchronicznych

Oba można łączyć: Beel API dla istniejącej synchronizacji z BaseLinkera, API natywne dla nowych funkcji. Te same dane (zamówienia, produkty) są widoczne w obu.