API WMS

Dokumentacja

Instancja lokalna WMS API wymaga zainstalowanego Windows Hosting Bundle

Aktualna dokumentacja API WMS dostępna jest w formacie Swagger

Technologia

API WMS udostępnione jest 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.

Mniejsze zmiany zachowujące kompatybilność wsteczną będą nanoszone na bieżąco bez informowania użytkowników.

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
• Poprawki w dokumentacji Swagger
• Dodanie nowego endpointu

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

Uwierzytelnianie

Autoryzacja do API odbywa się poprzez token Auth0 uzyskany poprzez logowanie do konta Futuriti (jak pobrać token)

Zastosowanie

API WMS pozwala programistom na integrację z systemem Futuriti WMS w celu pobierania/wstawiania danych do wybranych instancji uwzględniając zasadnicze procesy, co z kolei zapewnia spójność danych