API

Program 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, VSS.net umożliwia płynną i nieograniczoną wymianę danych, obejmujących różnorodne aspekty takie jak przyjmowanie i wydawanie towarów, aktualny stan magazynowy oraz informacje na temat klientów i kontrahentów.

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

API (Application Programming Interface) w systemie Studio TCS.net to zestaw interfejsów. Umożliwiają one integrację systemu z innymi aplikacjami używanymi w firmie. Należą do nich systemy takie jak ERP, TMS, WMS i CRM. Możliwa jest także integracja z systemami zewnętrznych przewoźników. Dzięki API możliwa jest automatyczna wymiana danych. W konsekwencji eliminuje to potrzebę ręcznego wprowadzania informacji. Przyspiesza również procesy logistyczne.

API w Studio TCS.net pozwala na zdalne przesyłanie, pobieranie i aktualizowanie danych. Dotyczą one awizacji, harmonogramów, statusów transportów, kontrahentów czy informacji o pojazdach. Możesz na przykład automatycznie wysyłać awizacje z systemu ERP do TCS.net albo pobierać informacje o statusach dostaw do platformy B2B klienta. Komunikacja odbywa się za pomocą bezpiecznych protokołów (np. REST API z obsługą JSON), co gwarantuje stabilność i ochronę danych.

Dzięki wykorzystaniu API możliwe jest tworzenie własnych aplikacji, automatyzacja powtarzalnych zadań oraz integracja z portalami klientów lub partnerów logistycznych. Przykładowo – przewoźnik może przez własny system zarezerwować okno czasowe w TCS.net bez potrzeby logowania się do panelu. Firmy mogą też ustawiać powiadomienia, synchronizować dane kontrahentów lub wprowadzać dane bezpośrednio z zewnętrznych systemów planowania.

Funkcja API w Studio TCS.net znacząco zwiększa elastyczność systemu. Pozwala także dostosować go do indywidualnych potrzeb firmy. API ułatwia budowanie jednolitego środowiska IT. Wspiera cyfryzację procesów. Co ważne, zmniejsza ryzyko błędów wynikających z ręcznego przepisywania danych. To nowoczesne rozwiązanie pozwala w pełni wykorzystać potencjał automatyzacji w logistyce i zarządzaniu transportem.

Application Programming Interface

Integracja Studio TCS.net z innymi systemami

Dzięki modułowi API zintegrowanie Studio TCS.net z popularnymi systemami księgowymi, rachunkowymi czy finansowymi staje się łatwe i bezproblemowe. Dane są automatycznie i natychmiast pobierane przez system TCS.net, nie wymagając żadnych dodatkowych działań od użytkowników.

Wykorzystanie pełnych możliwości API sprawi, że działania związane z obsługą towaru staną się bardziej efektywne i znacznie przyspieszone. Studio TCS.net umożliwia tworzenie dedykowanych procesów wymiany informacji. Pozwala to na automatyczne przesyłanie danych do biura rachunkowego czy innych systemów wspierających zarządzanie firmą.

Wykorzystanie zaawansowanego modułu API programu Studio TCS.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

W dzisiejszych czasach wykorzystanie API webowych stało się nieodłączną częścią architektury oprogramowania. Jednym z najpopularniejszych i najczęściej wykorzystywanych stylów architektury jest REST (representational state transfer). REST w prosty i intuicyjny sposób umożliwia komunikację między różnymi 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 staje się sprawniejsza i bardziej efektywna. W konsekwencji przyczynia się to do wydajniejszego funkcjonowania systemów informatycznych oraz usprawnia działanie wielu przedsiębiorstw.

Dokumentacja Swagger YAML lub JSON

Integracja API, szczególnie przy wykorzystaniu preferowanej architektury REST, odgrywa kluczową rolę w rozwijaniu nowoczesnych aplikacji internetowych i mobilnych. Dzięki interfejsowi programowania aplikacji (API) możliwe jest efektywne komunikowanie się między różnymi systemami i aplikacjami, umożliwiając 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 kluczową 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 w formacie YAML oraz możliwość edycji w czasie rzeczywistym za pomocą Swagger to znaczący atut dla zespołów programistycznych. W rezultacie pozwala to na bieżące dostosowywanie dokumentacji do zmieniających się wymagań projektowych. Tym samym przyczynia się do sprawnego rozwoju aplikacji. Ponadto, integracja API z wykorzystaniem preferowanego REST i dokumentacja w formacie YAML z edycją w Swagger stanowią kluczowe elementy w rozwijaniu nowoczesnych aplikacji. Dzięki nim programiści mogą sprawnie wymieniać się informacjami między różnymi systemami i aplikacjami. Co więcej, przekłada się to na wydajność, skalowalność i lepsze doświadczenia użytkowników.

WebAPI Studio TCS.net

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

W sekcji tags znajdują się kategorie, które grupują ścieżki. Z kolei w paths znajdziesz konkretne ścieżki dostępne w API. W tym przykładzie jest tylko jedna ścieżka /ApiService.asmx/Execute, która obsługuje żądania typu POST.

W sekcji parameters znajdziesz jeden parametr body. Jest to obiekt typu ApiExecuteRequest i przekazuje się go w żądaniu POST. Natomiast w sekcji responses opisano odpowiedzi serwera dla każdego możliwego przypadku. To na przykład 200 dla udanego wykonania żądania, 401 dla nieprawidłowych danych uwierzytelniających i 400 dla nieprawidłowych danych żądania.

Swagger to bardzo przydatne narzędzie do dokumentowania API. Pomaga programistom w łatwym zrozumieniu API. Ułatwia im także testowanie i korzystanie z API. Ponadto, dokumentacja REST API opisuje zbiór dostępnych punktów końcowych (endpoints) oraz możliwości, jakie oferuje API Studio TCS.net. Poniżej przedstawiamy opis poszczególnych punktów końcowych oraz ich funkcjonalności.

/ApiService.asmx/Execute

Metoda: POST

Opisuje uniwersalną metodę API. Należy użyć pól „actionUid” i „actionData”. Pierwsze pole to unikalny identyfikator operacji (guid). Drugie pole to dopasowany obiekt dla tej operacji (jeden z obiektów ApiExecuteRequest). Metoda ta 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:

1. Sprawdź wersję bazy danych. Upewnij się, że baza ma ustawiony parametr „compatibility level” na wartość 130 lub wyższą.
2. 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ę.
3. 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ę.
4. Wykonaj logikę w procedurze. W procedurze, którą wywoła polecenie SQL, odbierz dane przesłane jako „actionData” i wykonaj na nich odpowiednią logikę.
5. Zwróć wynik z procedury. Procedura powinna zwrócić wynik w formie obiektu JSON, który zostanie zwrócony przez API jako odpowiedź.
6. 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 (typ danych zdefiniowany w definicjach).

Odpowiedzi:

„200”: Kod API został wykonany z błędem lub bez błędu. Zwraca tablicę obiektów ApiExecuteResponse (typ danych zdefiniowany w definicjach).

„401”: Nieprawidłowe dane uwierzytelniające. Zwraca obiekt ErrorResponse (typ danych zdefiniowany w definicjach).

„400”: Nieprawidłowe dane żądania. Zwraca obiekt ErrorResponse (typ danych zdefiniowany w definicjach).