Czym jest API?
API to interfejs programowania aplikacji (od ang. Application Programming Interface). Jest zbiorem reguł, które w ścisły sposób opisują w jaki sposób programy i podprogramy komunikują się ze sobą. API akceptuje format danych JSON.
Główne metody API:
- GET – służy do pobierania danych (np. wyświetlania listy materiałów)
- POST – tworzy nowe dane (np. dodaje nowego odbiorcę)
- PUT – aktualizuje wcześniej dodane zasoby (np. wprowadza zmiany do materiału)
- DELETE – służy do usuwania danych
Co to w praktyce oznacza?
W praktyce oznacza to, że każdą funkcję znajdującą się w systemie można wywołać poprzez API. Dzięki temu możliwa jest integracja systemów z Weaver WMS w standaryzowany sposób. Partner lub firma trzecia może poprzez API wykonać szereg operacji, które umożliwią integrację z innym systemem.
Przykładowe operacje możliwe do wykonania poprzez REST API:
- Pobranie listy materiałów
- Dodanie odbiorcy
- Pobranie listy WZ oczekujących na realizację
- Dodanie awiza dokumentu PZ
- Pobranie listy wykonanych w WMS inwentaryzacji
100% logiki aplikacji Weaver WMS dostępna jest poprzez API.
Z technicznego punktu widzenia...
Działanie struktury API Weaver WMS, opisane jest w dedykowanym artykule tutaj. Przedstawia on między innymi proces konfiguracji API w systemie magazynowym oraz wykonywanie autoryzacji i ogólne działanie całego interfejsu.
Swagger
Swagger pozwala na sprawdzanie poszczególnych adresów URI (tzw. endpointó'w). Cała lista dostępnych metod znajduje się tutaj.