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.
Rozwój i zmiany w działaniu endpointów
Wszystkie zmiany mające wpływ na zerwanie kompatybilności wstecznej (tzw. breaking changes) będą odpowiednio wcześnie zgłaszane użytkownikom. Zmiany zachowujące kompatybilność wsteczną będą udostępniane są na bieżąco bez uprzedzania użytkowników.
Informacje o zmianach i nowościach publikujemy na grupie API xSale.
Co nie łamie kompatybilności wstecznej?
- Dodatkowe pola w zwracanych odpowiedziach z endpointów GET
- Dodatkowe nie wymagane pola w endpointach POST/PUT
- Dodatkowe filtry w endpointach GET
- Dodatkowe sortowania w endpointach GET
- Drobne poprawki w Swagger
- Dodanie nowego endpointa
Co łamie kompatybilność wsteczna?
- Usunięcie lub zmiana nazwy pola w endpointach GET/POST/PUT
- Usunięcie lub zmiana nazwy filtra
- Usunięcie lub zmiana nazwy sortowania
- Zmiana struktury odpowiedzi lub danyh przyjmowanych przez endpoint
- Zmiana kodu odpowiedzi
- Zmiana ścieżki lub usunięcie endpointa
- Zmiana metody http w endpoincie
Uwierzytelnienie
Logowanie do API odbywa się danymi dostępowymi do xSale, uwierzytelnienie oparte jest o najlepsze aktualne praktyki i technologię Auth0. Zobacz wpis dotyczący wygenerowania dostępów.
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.
Zobacz przykładowe przypadki użycia.
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
Masz pytania do API?
Jeżeli masz pytania do API xSale to prosimy:
- Zobacz dokumentacje API.
- Zobacz typowe przypadki użycia.
- Zwróć uwagę, że cały interfejs v2 działa przez API, więc korzystając z narzędzi developerskich przeglądarki, możesz również prześledzić komunikacje i wywołania poszczególnych endpointów.
- Zobacz na grupę API, poszukaj tam odpowiedzi, zadaj tam pytanie.
- Jeżeli dalej masz problem, i skorzystałeś z ww. kroków i jednocześnie nie uzyskałeś odpowiedzi, to postaramy się pomóc przez helpdesk, skontaktuj się z nami.
