Bezpłatna 15-minutowa konsultacja bezpośrednio z naszymi ekspertami.
Admin API to interfejs, przez który Shopware 6 jest zarządzany z zewnątrz: pozwala odczytywać i zapisywać produkty, stany magazynowe, zamówienia, klientów i ustawienia. To standardowy sposób łączenia sklepu z systemami ERP, PIM, CRM i middleware, także w sklepach działających w Polsce, które współpracują z lokalnymi systemami ERP i magazynowymi.
Wszystko, co mogą Państwo zrobić w panelu administracyjnym Shopware 6, można wykonać również przez Admin API: tworzyć produkty, zmieniać stany magazynowe, odczytywać zamówienia, aktualizować dane klientów, zmieniać statusy. Sam panel administracyjny jest tylko jednym z klientów tego API; każda akcja w backendzie to wywołanie API.
Właśnie dlatego Admin API jest standardową drogą integracji z systemami zewnętrznymi. ERP, PIM, systemy magazynowe, CRM i middleware komunikują się z Shopware przez ten interfejs, zwykle w tle i bez udziału użytkownika. API działa w oparciu o REST, zwraca dane w formacie JSON i obejmuje wszystkie encje Data Abstraction Layer.
Shopware 6 udostępnia dwa interfejsy, które często są mylone:
/api/.sw-access-key, endpointy pod /store-api/.Prosta zasada: to, co pracownik robi w panelu administracyjnym, należy do Admin API. To, co klient robi w sklepie, należy do Store API. Szczegółowe różnice wyjaśniamy w artykule o GraphQL i REST API w Shopware.
Dostęp odbywa się przez OAuth 2.0. Na potrzeby integracji systemów tworzą Państwo w Ustawienia → System → Integracje integrację z własną rolą i otrzymują identyfikator klucza dostępu oraz klucz bezpieczeństwa. Za ich pomocą pobierają Państwo token:
POST /api/oauth/token
{
"grant_type": "client_credentials",
"client_id": "ID_KLUCZA_DOSTEPU",
"client_secret": "KLUCZ_BEZPIECZENSTWA"
}
Token jest ważny dziesięć minut i przesyła się go w nagłówku Authorization: Bearer. Dla narzędzi działających w imieniu użytkownika dostępny jest dodatkowo typ grantu password z tokenem odświeżania. Każdej integracji należy nadać tylko te uprawnienia, których potrzebuje dany proces; za pomocą ról ACL dostęp można ograniczyć aż do pojedynczych encji i operacji. Więcej o samym protokole znajdą Państwo w haśle OAuth.
GET /api/product, POST /api/product, PATCH /api/product/{id}, DELETE /api/product/{id}, analogicznie dla zamówień, klientów, kategorii, mediów i wszystkich pozostałych encji.POST /api/search/product z filtrami, sortowaniem, paginacją, agregacjami i asocjacjami. W ten sposób można np. jednym wywołaniem pobrać wszystkie zamówienia z danego dnia wraz z pozycjami.POST /api/_action/sync zapisuje wiele rekordów różnych encji w jednym żądaniu. To właściwa droga do synchronizacji stanów i cen dla tysięcy produktów./api/_action/order/{id}/state/…), generowanie dokumentów, wysyłka e-maili, uruchamianie indeksowania./api/_info/ zwraca wersję, dostępne encje i schemat OpenAPI; interfejs Swagger pod /api/_info/swagger.html dokumentuje wszystkie endpointy.W typowej integracji z ERP Admin API obsługuje następujące przepływy danych:
Zamiast cyklicznego odpytywania mogą Państwo otrzymywać powiadomienia od Shopware: webhooki informują o nowych zamówieniach lub zmienionych produktach, a integracja pobiera tylko to, co się zmieniło. Jakie systemy można w ten sposób podłączyć, pokazuje nasz przegląd integracji ERP i CRM, a konkretny przykład opisuje poradnik Xentral i Shopware 6.
updatedAt lub webhookom przesyłają Państwo tylko różnice zamiast całego zbioru danych.indexing-behavior: use-queue-indexing można przenieść indeksowanie do kolejki.Admin API to kręgosłup każdej integracji Shopware. Kto rozumie jego logikę, czyli OAuth 2.0, wyszukiwanie z kryteriami, Sync API i State Machine, może niezawodnie połączyć sklep z ERP, PIM i CRM. Przy indywidualnych integracjach i wtyczkach, które rozszerzają Admin API o własne endpointy, chętnie wspieramy również sprzedawców z Polski w ramach tworzenia wtyczek Shopware.