1. Dokumentacja
  2. Współpraca z ERP
  3. API xSale
  4. Dokumentacja i dostęp do API xSale

Dokumentacja i dostęp do API xSale

Dokumentacja

Aktualna dokumentacja API xSale dostępna jest w formacie Swagger: https://api.xsale.ai/swagger

Technologia

API xSale jest udostępnione w technologii REST

Uwierzytelnienie

Konta API są tworzone przez Helpdesk bezpłatnie na prośbę klienta

Zastosowanie

API xSale umożliwia programistom integracje m.in. z własnym, dedykowanym systemem ERP lub dostęp do wspieranych ERP przez REST API xSale i inne dedykowane zastosowania.

API xSale można wykorzystać również jako REST API do Comarch ERP Optima lub REST API do Comarch ERP XL dzięki temu możliwie jest np. pobieranie przez API informacji z Comarch Optima oraz pobieranie przez API z Comarch XL (np. o kontrahentach, towarach), a także dodawanie danych np. dodawanie płatności przez API do Comarch Optima lub dodawanie kontrahentów przez API do Comarch XL

Autoryzacja aplikacji z API xSale

Poza logowaniem się przy użyciu loginu i hasła, API xSale może być również połączone z aplikacjami. Poniżej przesyłamy opis wymaganych informacji, potrzebnych do autoryzowania aplikacji z API xSale.

Aplikacja: „Regular Web Application” (https://auth0.com/docs/quickstart/webapp)
Flow: „Authorization Code”
Rodzaj aplikacji, w której użytkownik przekierowany jest na stronę logowania i poproszony o podanie loginu oraz hasła.
Po udanej próbie logowania, aplikacja otrzymuje Access Token oraz opcjonalnie ID Token (https://auth0.com/docs/tokens). Access Token wykorzystywany jest do autoryzacji w xSale REST API.

W przypadku „Regular Web Application” potrzebujemy znać następujące adresy:
– Adres logowania, który przekierowuje na formularz logowania Auth0 (np. https://myapp.com/login).
– Adres callback, pod który wysłany zostanie kod autoryzacyjny (authorization_code) potrzebny do wygenerowania tokena (np. https://myapp.com/oauth/callback).
– Adres wylogowania, na który zostanie przekierowany użytkownik po wylogowaniu się z Auth0 (np. https://myapp.com/seeyou).

Potrzebna jest również lista adresów e-mail użytkowników, którzy mają otrzymać dostęp do xSale REST API.

Aplikacja: „Backend API” (https://auth0.com/docs/quickstart/backend)
Flow: „Resource Owner Password Credentials”
Rodzaj aplikacji, w której nie ma interakcji z użytkownikiem (np. skrypt CLI uruchamiany w tle).
Aplikacja uwierzytelnia się przesyłając dane autoryzacyjne wraz z loginem i hasłem użytkownika. Po udanym uwierzytelnianiu otrzymuje Access Token oraz opcjonalnie ID Token (https://auth0.com/docs/tokens). Access Token wykorzystywany jest do autoryzacji w xSale REST API.

Potrzebna jest lista adresów e-mail użytkowników, którzy mają otrzymać dostęp do xSale REST API.

Czy ten artykuł jest wystarczająco pomocny? Tak Nie

Co możemy poprawić?