EN
W tym artykule znajdziesz
- kiedy użyć kreatora API xSale,
- jak utworzyć integrację krok po kroku,
- jakie typy aplikacji są dostępne w kreatorze,
- jakie dane autoryzacyjne są wyświetlane po utworzeniu integracji,
Kiedy stosować kreator API xSale?
Utwórz tę integrację, gdy chcesz połączyć xSale z systemem zewnętrznym, na przykład ERP, WMS albo własną aplikacją, która będzie korzystać z REST API xSale.
Jak utworzyć integrację?
Przejdź w panelu xSale do sekcji Integracje → Integracje i znajdź pozycję API xSale.
Otwórz kreator API xSale i uzupełnij:
- Nazwa integracji – wpisz nazwę, która pozwoli rozpoznać połączenie. Nazwa jest wymagana, a po utworzeniu integracji nie można jej zmienić.
- Typ aplikacji – wybierz Native albo Regular Web Application. Domyślnie wybrany jest typ Native.
Kliknij Dodaj integrację. Po utworzeniu integracji nazwa i typ aplikacji są zablokowane do edycji.
Jakie dane otrzymasz po utworzeniu integracji?
Po utworzeniu integracji otworzy się widok z danymi potrzebnymi do autoryzacji połączenia:
- Domena – adres serwera autoryzacji:
https://login.futuriti.pl/oauth/token, - Typ aplikacji – wybrany podczas tworzenia integracji,
- Client Id – identyfikator aplikacji,
- Pełna nazwa organizacji (organizationName) – nazwa organizacji używana w adresach endpointów API.
Dla typów Native i Regular Web Application xSale korzysta z platformowych danych aplikacji, dlatego w tym widoku nie pojawia się osobny Client Secret.
Jak wykorzystać dane autoryzacyjne?
Sposób autoryzacji zależy od wybranego typu aplikacji:
Opis dostępnych endpointów REST API znajduje się w dokumentacji Swagger xSale REST API.
Typowe problemy
- Nie widzę integracji API xSale – sprawdź, czy masz dostęp do sekcji Integracje i odpowiednie uprawnienia.
- Nazwa integracji jest nieprawidłowa – wpisz nazwę o długości od 1 do 200 znaków.
- Nie mogę utworzyć integracji – sprawdź, czy wybrano typ aplikacji i czy masz uprawnienia do zarządzania integracjami.
- Autoryzacja nie działa – sprawdź, czy używasz właściwego typu aplikacji, Client Id, pełnej nazwy organizacji oraz sposobu autoryzacji opisanego w odpowiedniej instrukcji.