API

Program magazynowy WMS.net oferuje zaawansowany technologicznie moduł API (Application Programming Interface), który rewolucjonizuje komunikację z innymi systemami dostępnymi na rynku. Dzięki temu nowatorskiemu modułowi, WMS.net umożliwia płynną i nieograniczoną wymianę danych, obejmujących różnorodne aspekty takie jak przyjmowanie i wydawanie, aktualny stan magazynowy oraz informacje na temat klientów i kontrahentów.

API. Studio WMS.net, SoftwareStudio Sp. z o.o.

Jak działa moduł API w systemie Studio WMS.net i do czego służy?

Moduł API w Studio WMS.net wspiera integrację z innymi systemami. Automatyzuje przepływ danych między programami. Dzięki temu obsługa magazynu staje się szybsza i prostsza.

API, czyli interfejs programowania aplikacji, pozwala systemowi WMS wymieniać dane z zewnętrznymi programami. Może to być system księgowy, ERP lub platforma sprzedażowa. Połączenie odbywa się automatycznie, bez udziału użytkownika. Dzięki temu dane są zawsze aktualne i spójne. API działa w tle, nie zakłócając pracy magazynu.

W praktyce API umożliwia pobieranie i przesyłanie informacji, np. dokumentów sprzedaży, faktur, stanów magazynowych czy kartotek towarowych. System WMS może natychmiast odebrać dane o nowym zamówieniu i rozpocząć jego realizację. Eliminuje to ręczne wprowadzanie danych i zmniejsza ryzyko błędów. Wszystko dzieje się automatycznie i w czasie rzeczywistym. Użytkownicy zyskują na czasie i efektywności.

Moduł API wspiera nowoczesne zarządzanie magazynem. Integracja z innymi systemami pozwala budować spójne środowisko pracy. Dane przepływają płynnie między działami firmy. To ułatwia planowanie, kontrolę i raportowanie. Studio WMS.net dzięki API staje się elastycznym narzędziem dostosowanym do różnych potrzeb biznesowych.

Application Programming Interface

Zintegrowanie programu WMS.net z popularnymi systemami księgowymi, rachunkowymi czy finansowymi staje się łatwe i bezproblemowe dzięki możliwościom modułu API. Dane są automatycznie i natychmiast pobierane przez system WMS, nie wymagając żadnych dodatkowych działań ze strony użytkowników.

Dzięki wykorzystaniu pełnych możliwości API, Twoje działania związane z obsługą towaru staną się nie tylko bardziej efektywne, ale także znacznie przyspieszone. Program WMS.net umożliwia tworzenie dedykowanych procesów wymiany informacji, co pozwala na automatyczne przesyłanie danych do biura rachunkowego czy innych systemów wspierających zarządzanie firmą.

Bez wątpienia, wykorzystanie zaawansowanego modułu API programu WMS.net otwiera nowe perspektywy dla Twojej firmy. Integracja z innymi systemami staje się prostsza niż kiedykolwiek wcześniej, co pozwala na pełne wykorzystanie potencjału technologicznego w zarządzaniu magazynem. Dzięki temu zyskasz znaczącą przewagę konkurencyjną, zapewniając płynne i efektywne działanie Twojego przedsiębiorstwa.

WebAPI REST

Obecnie API webowe są istotnym elementem architektury oprogramowania. REST jest jednym z najpopularniejszych stylów architektury. REST umożliwia prostą i intuicyjną komunikację między aplikacjami. Wykorzystuje do tego standardowe protokoły internetowe.

Główną zaletą REST jest jego prostota i skalowalność. Komunikacja odbywa się poprzez wywołanie usługi interfejsu za pomocą URI (Uniform Resource Identifier) wraz z odpowiednimi parametrami. Dzięki temu, interakcja z API jest łatwa do zrozumienia i implementacji, co pozwala na szybkie rozwijanie i integrowanie różnych systemów.

Wynik działania usługi REST jest zazwyczaj zakodowany w formacie JSON (JavaScript Object Notation) lub XML (eXtensible Markup Language), co pozwala na łatwe przekazywanie danych w strukturalny sposób. JSON jest coraz bardziej popularnym formatem ze względu na jego czytelność i lekkość, co przekłada się na szybszy czas przetwarzania i mniejsze obciążenie sieci.

REST jako styl architektury jest również niezwykle skalowalny, co oznacza, że może obsłużyć duże ilości żądań i użytkowników bez utraty wydajności. Jest to szczególnie istotne w przypadku aplikacji, które potrzebują szybkiego i niezawodnego dostępu do danych.

Wydajność, prostota i skalowalność to tylko niektóre zalety REST. Dlatego jest on preferowanym stylem architektury dla API webowych. Dzięki niemu komunikacja między aplikacjami jest sprawniejsza i bardziej efektywna. W rezultacie przyczynia się to do wydajniejszego funkcjonowania systemów informatycznych i usprawnia działanie wielu przedsiębiorstw.

Dokumentacja Swagger YAML lub JSON

Integracja API odgrywa istotną rolę w rozwijaniu nowoczesnych aplikacji internetowych i mobilnych. Szczególnie istotne jest to przy wykorzystaniu preferowanej architektury REST. Bowiem dzięki interfejsowi programowania aplikacji (API) możliwa staje się efektywna komunikacja między różnymi systemami i aplikacjami. W konsekwencji umożliwia to wymianę informacji w szybki i elastyczny sposób.

REST (Representational State Transfer) to popularna architektura oprogramowania, która określa zasady i ograniczenia projektowania API. Jego prostota i elastyczność czynią go preferowanym wyborem dla tworzenia interfejsów programowania. REST opiera się na wykorzystaniu standardowych protokołów internetowych, takich jak HTTP, co pozwala na łatwe korzystanie z API bez potrzeby specjalnych narzędzi czy dodatkowych zależności.

Dokumentacja API odgrywa istotną rolę w procesie rozwoju aplikacji. Swagger, narzędzie do tworzenia dokumentacji API w formacie YAML, jest jednym z najpopularniejszych rozwiązań. Swagger ułatwia tworzenie i zarządzanie dokumentacją API, zgodną z wymaganiami OpenAPI (OAI). Dzięki temu programiści mają łatwy dostęp do informacji na temat dostępnych punktów końcowych API, sposobu korzystania z nich oraz przekazywania parametrów.

Wykorzystanie dokumentacji YAML oraz edycja w czasie rzeczywistym w Swagger to znaczący atut dla zespołów programistycznych. Umożliwia to bieżące dostosowywanie dokumentacji do zmieniających się wymagań projektowych. W konsekwencji przyczynia się to do sprawnego rozwoju aplikacji.

Integracja API z preferowanym REST oraz dokumentacja YAML z edycją w Swagger stanowią istotne elementy w rozwijaniu nowoczesnych aplikacji. Dzięki nim programiści mogą sprawnie wymieniać informacje między różnymi systemami i aplikacjami. Przekłada się to na wydajność, skalowalność i lepsze doświadczenia użytkowników.

WebAPI WMS

Ten fragment kodu to Swagger Specification w wersji 2.0, czyli format dokumentacji dla API. Zawiera on informacje dotyczące API, takie jak opis, wersja, nazwa, host i ścieżka bazowa.

W sekcji „tags" znajdują się kategorie do grupowania ścieżek. Natomiast w „paths" są konkretne ścieżki API. W tym przykładzie istnieje tylko jedna ścieżka: „/ApiService.asmx/Execute". Obsługuje ona żądania POST.

W sekcji „parameters" znajduje się jeden parametr: „body". Jest to obiekt typu „ApiExecuteRequest". Przekazuje się go w żądaniu POST. W sekcji „responses" opisano odpowiedzi serwera. Dotyczy to każdego możliwego przypadku. Na przykład „200" oznacza udane wykonanie żądania. „401" wskazuje na nieprawidłowe dane uwierzytelniające. Z kolei „400" oznacza nieprawidłowe dane żądania.

Swagger to bardzo przydatne narzędzie do dokumentowania API. Pomaga programistom łatwo zrozumieć, testować i korzystać z API. Ponadto dokumentacja REST API opisuje dostępne punkty końcowe (endpoints). Przedstawia również możliwości, jakie oferuje API StudioSystem. Poniżej przedstawiony jest opis poszczególnych punktów końcowych oraz ich funkcjonalności:

/ApiService.asmx/Execute

Metoda: POST

Opisuje uniwersalną metodę API. W tym celu użyj pól „actionUid" i „actionData". Pierwsze pole, „actionUid", to unikalny identyfikator operacji (guid). Drugie pole, „actionData", to dopasowany obiekt dla tej operacji (jeden z obiektów ApiExecuteRequest). Metoda zwraca jeden z obiektów ApiExecuteResponse.

Metoda ta przyjmuje jako parametr „actionUid", który jest identyfikatorem polecenia SQL z tabeli „_code_sql". W ramach tego polecenia SQL może być wywołana procedura, która otrzymuje dane w formie JSON przekazane jako „actionData". Procedura może następnie wykonać dowolną logikę, korzystając z przesłanych danych, i zwrócić wynik w postaci JSON, który będzie zwracany jako odpowiedź z API.

Oto kroki, które można podjąć, aby skorzystać z tej dedykowanej metody API:

Sprawdź wersję bazy danych. Upewnij się, że baza ma ustawiony parametr „compatibility level" na wartość 130 lub wyższą.
Przygotuj dane do wykonania operacji. Przygotuj dane, które zostaną przekazane do API jako „actionData". Może to być dowolny obiekt JSON, który zostanie przetworzony przez procedurę.
Wykonaj dedykowaną metodę API. Wywołaj dedykowaną metodę API, przekazując jako parametr „actionUid" identyfikator polecenia SQL z tabeli „_code_sql", a jako „actionData" dane do przetworzenia przez procedurę.
Wykonaj logikę w procedurze. W procedurze, którą wywoła polecenie SQL, odbierz dane przesłane jako „actionData" i wykonaj na nich odpowiednią logikę.
Zwróć wynik z procedury. Procedura powinna zwrócić wynik w formie obiektu JSON, który zostanie zwrócony przez API jako odpowiedź.
Obsłuż odpowiedź z API. Otrzymasz odpowiedź z API zawierającą wynik z procedury w postaci pliku JSON. Możesz ten wynik przetworzyć i użyć go w dalszej części aplikacji.

Ważne jest również upewnienie się, że connection string do bazy danych, który będzie wykorzystywany w kodzie SQL, jest prawidłowy i umożliwia połączenie z bazą danych.

Parametry: „body" (w ciele zapytania): Obiekt ApiExecuteRequest.

Odpowiedzi: „200": Kod API został wykonany. „401": Nieprawidłowe dane uwierzytelniające. „400": Nieprawidłowe dane żądania.

/dpmag.asmx/GetDocumentsByAwizo

Metoda: POST

Opis: Pobiera dokumenty na podstawie numeru awizo.

Parametry: „body": Obiekt AuthData – dane uwierzytelniające. „nrawizo": Numer awizo (wymagany). „pageSize": Rozmiar strony (opcjonalny). „pageNumber": Numer strony (opcjonalny).