API

Moduł API (Application Programming Interface) w systemie Studio VSS.net umożliwia integrację z zewnętrznymi aplikacjami i automatyczną wymianę danych. Dzięki temu VSS.net łączy się z systemami ERP, TMS, WMS i CRM, obsługując takie dane jak przyjęcia i wydania towarów, aktualny stan magazynowy oraz informacje o klientach i kontrahentach.

Do czego służy API w systemie Studio VSS.net?

API w Studio VSS.net to zestaw interfejsów umożliwiających integrację systemu z innymi aplikacjami używanymi w firmie. Możliwa jest integracja z systemami ERP, TMS, WMS i CRM, a także z systemami zewnętrznych przewoźników. Dzięki API możliwa jest automatyczna wymiana danych - eliminuje to potrzebę ręcznego wprowadzania informacji i przyspiesza procesy logistyczne.

API pozwala na zdalne przesyłanie, pobieranie i aktualizowanie danych dotyczących awizacji, harmonogramów, statusów transportów, kontrahentów czy informacji o pojazdach. Przykładowo - awizacje z systemu ERP można automatycznie wysyłać do VSS.net albo pobierać informacje o statusach dostaw do platformy B2B klienta. Komunikacja odbywa się za pomocą bezpiecznych protokołów REST API z obsługą JSON, co gwarantuje stabilność i ochronę danych.

Przewoźnik może przez własny system zarezerwować okno czasowe w VSS.net bez potrzeby logowania się do panelu. Firmy mogą też synchronizować dane kontrahentów lub wprowadzać dane bezpośrednio z zewnętrznych systemów planowania. Funkcja API w Studio VSS.net zwiększa elastyczność systemu i pozwala dostosować go do indywidualnych potrzeb firmy.

WebAPI REST

Naszym preferowanym stylem architektury dla API jest REST (Representational State Transfer). REST umożliwia komunikację między różnymi aplikacjami w prosty i intuicyjny sposób, korzystając ze standardowych protokołów internetowych.

Komunikacja odbywa się przez wywołanie usługi interfejsu za pomocą URI (Uniform Resource Identifier) wraz z odpowiednimi parametrami. Wynik działania usługi REST jest kodowany w formacie JSON (JavaScript Object Notation) lub XML, 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.

Dokumentacja Swagger YAML lub JSON

Dokumentacja API odgrywa ważną rolę w procesie rozwoju aplikacji. Swagger, narzędzie do tworzenia dokumentacji API w formacie YAML, jest jednym z najbardziej popularnych 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.

Możliwość edycji dokumentacji w czasie rzeczywistym za pomocą Swagger to istotny atut dla zespołów programistycznych - pozwala na bieżące dostosowywanie dokumentacji do zmieniających się wymagań projektowych.

WebAPI VSS - dostępne punkty końcowe

Interfejs WebAPI programu VSS.net oferuje konkretne punkty końcowe umożliwiające wykonywanie różnych operacji. Poniżej przedstawiamy opis poszczególnych endpointów:

/ApiService.asmx/Execute

Metoda: POST. Opisuje uniwersalną metodę API. Należy użyć pól actionUid (unikalny identyfikator operacji - guid) i actionData (dopasowany obiekt dla tej operacji). Metoda zwraca jeden z obiektów ApiExecuteResponse.

Aby skorzystać z tej metody: sprawdź wersję bazy danych (wymagany compatibility level 130+), przygotuj dane w formacie JSON jako actionData, wywołaj metodę z actionUid jako identyfikatorem polecenia SQL z tabeli _code_sql, a procedura zwróci wynik jako obiekt JSON.

Odpowiedzi: 200 - kod API wykonany (z błędem lub bez), 401 - nieprawidłowe dane uwierzytelniające, 400 - nieprawidłowe dane żądania.

/dpmag.asmx/GetDocumentsByAwizo

Metoda: POST. Pobiera dokumenty na podstawie numeru awizo. Parametry: AuthData (dane uwierzytelniające), nrawizo (numer awizo - wymagany), pageSize i pageNumber (opcjonalne). Zwraca tablicę obiektów DPMAG_DocumentResponse.

/dpmag.asmx/GetDocumentsByCustomer

Metoda: POST. Pobiera dokumenty na podstawie identyfikatora klienta. Parametry: AuthData, nridodn (ID klienta - wymagany), ean (opcjonalny), dateFrom, dateTo, pageSize, pageNumber.

/dpmag.asmx/AddOrder

Metoda: POST. Dodaje nowe zamówienie. Parametry: DPZLE_AddOrderRequest w ciele zapytania. Zwraca obiekt DPZLE_AddOrderResponse.

/dpmag.asmx/GetOrder

Metoda: POST. Pobiera zamówienie na podstawie numeru lub identyfikatora zamówienia. Parametry: DPZLE_GetOrderRequest. Zwraca DPZLE_GetOrderResponse.

/dpmag.asmx/AddAssortment i GetAssortment

Metoda: POST. AddAssortment dodaje nowy asortyment (parametr: KNASO_AddAssortmentRequest). GetAssortment pobiera asortyment na podstawie id, warehouse i department.

/dpmag.asmx/GetStock i GetStockDetails

Metoda: POST. GetStock pobiera stan asortymentu na podstawie magazynu i działu. GetStockDetails pobiera szczegółowy stan. Oba endpointy obsługują paginację (pageSize, pageNumber) i filtrowanie po dacie.

/dpmag.asmx/AddContractor

Metoda: POST. Dodaje nowego kontrahenta. Parametr: KNCRM_AddContractorRequest. Zwraca KNCRM_AddContractorResponse.

Pełna dokumentacja API jest dostępna w formacie Swagger YAML. Umożliwia ona testowanie endpointów bezpośrednio w przeglądarce oraz generowanie kodu klienckiego w popularnych językach programowania.