Do czego służy ta instrukcja
Ten artykuł pokazuje, jak skorzystać z kreatora „API xSale”, aby utworzyć integrację do xSale REST API. Kreator generuje aplikację w Auth0, która jest używana do autoryzacji połączenia.
W tym artykule znajdziesz
- kiedy użyć kreatora API xSale
- wymagania i informacje, które warto przygotować
- szybki przepis krok po kroku
- typowe problemy i sposób weryfikacji
Kiedy stosować
Ten kreator jest przydatny, gdy chcesz połączyć xSale z systemem zewnętrznym (np. ERP, WMS, własna aplikacja) i potrzebujesz danych autoryzacyjnych do REST API. Po utworzeniu integracji możesz korzystać z opisanych w dokumentacji endpointów.
Wymagania
- dostęp do panelu xSale i uprawnienia pozwalające zarządzać integracjami
- nazwa integracji (to jedyne wymagane pole w kreatorze)
Szybki przepis (krok po kroku)
- Wejdź na listę integracji w xSale.
- Na liście znajdź pozycję API xSale i otwórz kreator.
- Uzupełnij nazwę integracji i zapisz.
- Po utworzeniu integracji skopiuj wymagane dane dostępu (zgodnie z informacjami w kreatorze).
- Zweryfikuj połączenie w systemie zewnętrznym (np. wykonując zapytanie testowe do API).
Typowe problemy i jak je sprawdzić
- Nie widzę integracji „API xSale” — sprawdź, czy masz dostęp do sekcji Integracje i odpowiednie uprawnienia.
- Brak możliwości utworzenia integracji — zweryfikuj rolę użytkownika w xSale lub skontaktuj się z administratorem firmy.
- Błędy autoryzacji w systemie zewnętrznym — upewnij się, że używasz poprawnych danych wygenerowanych przez kreator.
Szczegóły techniczne
Kreator umożliwia wygenerowanie aplikacji w Auth0 używanej do łączenia z xSale REST API.
Na liście dostępnych integracji znajdź „API xSale” (Integracje \ Integracje)
Otwórz kreator i podaj nazwę integracji. Jest to jedyne pole, które trzeba wypełnić. Pozostałe pola nie są edytowalne i uzupełnią się same. Po utworzeniu integracji nie da się zmienić jej nazwy.
Kliknij na przycisk „Dodaj integrację”. Zostanie wygenerowany Client Secret i Client Id.
W górnej sekcji opisowej kreatora znajdziesz przydatne linki do rozpoczęcia pracy z REST API xSale.
Możliwe jest ponowne wygenerowanie klucza Client Secret. Wejdź do nowo utworzonej integracji i użyj opcji „Wygeneruj ponownie”. Dotychczasowy klucz Client Secret zostanie dezaktywowany.
