Scale Monitor REST API

1. Wprowadzenie

REST API Scale Monitor umożliwia integrację Scale Monitor z Twoimi systemami, oferując elastyczne rozwiązania dopasowane do potrzeb wymiany danych. Możesz pobierać dane ze Scale Monitor lub otrzymywać dane ważenia bezpośrednio do swojego systemu.

1.1. Możliwości integracji

Twój system wywołuje API Scale Monitor

• Pobieraj bieżące lub historyczne dane ważenia bezpośrednio z platformy Scale Monitor. • Uzyskaj dostęp do danych ważenia dostosowanych do swoich wymagań operacyjnych. • Wykorzystaj możliwości przetwarzania i przechowywania danych w Scale Monitor, aby uprościć przebieg pracy.

Scale Monitor wysyła dane ważenia do Twojego REST API

• Skonfiguruj Scale Monitor tak, aby wysyłał bieżące dane ważenia bezpośrednio do Twojej usługi internetowej. • Dostosuj zdarzenia wyzwalające wysyłkę i formaty danych do istniejących systemów. • Zachowaj pełną kontrolę nad odbiorem i przetwarzaniem danych w swojej infrastrukturze.

Twój system zapisuje ważenia w ScaleMonitor przez REST API

• Umożliwia zapisywanie ważeń z Twojego systemu w chmurze ScaleMonitor.

1.2. Główne korzyści

• Elastyczność: wybierz metodę integracji najlepiej dopasowaną do swojego modelu operacyjnego. • Komunikacja w czasie rzeczywistym: udostępniaj dane natychmiast między Scale Monitor a swoimi systemami. • Dostosowanie: dopasuj formaty danych, zdarzenia wyzwalające i przebieg pracy do procesów biznesowych. • Zgodność: współpracuje z każdą wagą lub urządzeniem ważącym, niezależnie od producenta.

1.3. Przykłady zastosowań• Automatycznie synchronizuj dane ważenia z systemami ERP, WMS lub LIMS. • Otrzymuj powiadomienia i aktualizacje danych w czasie rzeczywistym, aby precyzyjnie monitorować proces. • Uprość złożone procedury dzięki automatycznemu udostępnianiu i synchronizacji danych.

4. Tokeny API

REST API ScaleMonitor korzysta ze standardowych tokenów JWT udostępnianych na żądanie. Token należy wysłać wraz z żądaniem w nagłówku Authorization typu Bearer.

5. Metody API 5.1. Pobieranie ważeń

Punkt końcowy

POST /Api/ScaleMonitor/ScaleMonitorApi/getWeighings/

Opis

Pobiera listę ważeń Scale Monitor zgodnie z podanymi filtrami.

Żądanie

Nagłówki

Parametry POST (JSON BODY)

{ "dateTimeFrom": "2025-03-01", "dateTimeTo": "2025-03-25", "scaleId": 123 }

Odpowiedź

Odpowiedź potwierdzająca powodzenie ( 200 OK )

{ "data": { "numberOfWeighings": 1, "weighings": [ { "weighingNumber": 1432, "weighingDateTime": "2025-03-22 11:39:58", "gross": "1600 kg", "net": "0 kg", "tare": "0 kg", "stability": 0, "scaleData": { "title": "Ranger 3000", "inventoryNumber": "D23541", "uuid": "db33e782-45a3-11ef-9aad-f9b59ffd187f", "id": 123 }, "additionalParameters": [ { "parameterName": "Material", "value": "Nail", "uuid": "99703ee3-f8fe-11ef-8d03-00155de9e731" }, { "parameterName": "Material ID", "value": "SN94735", "uuid": "96703ee3-f8fe-11ef-8d03-00155de9e731" } ] } ] }, "error": 0 }

Odpowiedź z błędem ( 400 Bad Request lub 500 Internal Server Error )

{ "error": 1, "errorMessage": "Failed getting weighings: Internal server error" }

Punkt końcowy

POST /Api/ScaleMonitor/ScaleMonitorApi/saveWeighing/

Opis

Zapisuje ważenie w bazie danych ScaleMonitor.

Żądanie

Nagłówki

Parametry POST (JSON BODY)

Przykładowe żądanie

{ "scaleId": "123", "checkForDuplicates":false, "constantForDuplicate":"", "duplicateValueCheck":"", "parameters":[

{"constantName":"lot","value":"20250326001"}, {"constantName":"articleCode","value":"AB2025-16"}, {"constantName":"grossWeight","value":"12.4"}, {"constantName":"netWeight","value":"12.4"}, {"constantName":"tareWeight","value":"0"}, {"constantName":"unit","value":"g"} ] }

Odpowiedź potwierdzająca powodzenie ( 200 OK )

{ "data": { "text": "Weighing saved successfully", "weighingNumber": 253, "duplicateValueCheck": "", "weighingAdded": true }, "error": 0 }

Odpowiedź z błędem ( 400 Bad Request lub 500 Internal Server Error )

{ "error": 1, "errorMessage": "Failed while saving weighing: E:Error while retrieving ScaleMonitor data }

Stałe API konfiguruje się w ScaleMonitor na karcie „API settings”. W tabeli można wprowadzić stałą API, która odpowiada nazwie stałej wysyłanej do API. W kolumnie „parameter” wybierz parametr reprezentowany przez tę stałą. Parametry mogą być statyczne, np. masa brutto lub netto, albo dynamiczne, jak dodatkowe parametry definiowane samodzielnie, np. LOT lub kod artykułu.

5.3. Importowanie wpisów bazy danych przez API Punkt końcowy

POST /Api/DynamicEntityList/DynamicEntityListApi/insertDatabaseValue/

Opis

Importuje wiersze do wybranej bazy danych.

Żądanie

Nagłówki

Parametry POST (JSON BODY)

Obiekt JSON, którego nazwą jest kod bazy danych. Wewnątrz znajduje się tablica wierszy bazy danych; każdy wiersz ma kod parametru jako nazwę i wartość jako zawartość.

Nie ma limitu liczby wierszy i baz danych, które można wstawić jednocześnie.

Przykładowe żądanie

{ "Products": [ { "ID": "2025001", "Title": "Screw" }, { "ID": "2025002", "Title": "Bolt" } ] }

Odpowiedź

Odpowiedź potwierdzająca powodzenie

{ "msg": "Database values have been inserted successfully!", "error": 0 }

{ "error": 1 "errorMessage": "Error inserting database values: Attribute has not been found!Internal server error" }

6. Jak uzyskać ID wagi

ID wag są podane w każdej aplikacji ScaleMonitor dla odpowiednich wag. Rozwijane menu z ID wagi można otworzyć, klikając przycisk informacji — kółko z literą „i”.

7. Testowanie API

Do testowania zaleca się program taki jak ARC (Advanced rest client).

Test można wykonać po wprowadzeniu adresu URL, informacji nagłówków, danych autoryzacji i treści żądania.

Po wprowadzeniu wszystkich wymaganych informacji można wysłać dane i otrzymać odpowiedź, a następnie potwierdzić poprawność odpowiedzi i danych.