Scale Monitor REST API

1. Introduzione

La REST API di Scale Monitor consente di integrare Scale Monitor con i vostri sistemi, offrendo opzioni flessibili per le vostre esigenze di scambio dei dati. Potete recuperare dati da Scale Monitor oppure ricevere i dati di pesatura direttamente nel vostro sistema.

1.1. Opzioni di integrazione

Il vostro sistema richiama l’API di Scale Monitor

• Recuperate i dati di pesatura in tempo reale o storici direttamente dalla piattaforma Scale Monitor. • Accedete a dati di pesatura personalizzati in base alle vostre esigenze operative. • Utilizzate le funzioni di elaborazione e archiviazione dei dati di Scale Monitor per semplificare i flussi di lavoro.

Scale Monitor invia i dati di pesatura alla vostra REST API

• Configurate Scale Monitor per inviare i dati di pesatura in tempo reale direttamente al vostro servizio web. • Personalizzate gli eventi di invio e i formati dei dati per integrarli nei sistemi esistenti. • Mantenete il pieno controllo sulla ricezione e sull’elaborazione dei dati nella vostra infrastruttura.

Il vostro sistema memorizza le pesate in ScaleMonitor tramite REST API

• Consente di memorizzare le pesate del vostro sistema nel cloud ScaleMonitor.

1.2. Vantaggi principali

• Flessibilità: scegliete il metodo di integrazione più adatto al vostro modello operativo. • Comunicazione in tempo reale: condividete immediatamente i dati tra Scale Monitor e i vostri sistemi. • Personalizzazione: adattate formati dei dati, eventi di invio e flussi di lavoro ai vostri processi aziendali. • Compatibilità: funziona con qualsiasi bilancia o dispositivo di pesatura, indipendentemente dal produttore.

1.3. Casi d’uso• Sincronizzate automaticamente i dati di pesatura con i sistemi ERP, WMS o LIMS. • Ricevete notifiche e aggiornamenti dei dati in tempo reale per un monitoraggio preciso. • Semplificate i flussi di lavoro complessi con la condivisione e la sincronizzazione automatiche dei dati.

4. Token API

La REST API di ScaleMonitor utilizza token JWT standard, forniti su richiesta. Il token deve essere inviato con la richiesta tramite un’intestazione Authorization di tipo Bearer.

5. Metodi API 5.1. Recuperare le pesate

Endpoint

POST /Api/ScaleMonitor/ScaleMonitorApi/getWeighings/

Descrizione

Recupera un elenco delle pesate di Scale Monitor in base ai filtri indicati.

Richiesta

Intestazioni

Parametri POST (JSON BODY)

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

Risposta

Risposta riuscita ( 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 }

Risposta di errore ( 400 Bad Request oppure 500 Internal Server Error )

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

Endpoint

POST /Api/ScaleMonitor/ScaleMonitorApi/saveWeighing/

Descrizione

Salva una pesata nel database ScaleMonitor.

Richiesta

Intestazioni

Parametri POST (JSON BODY)

Esempio di richiesta

{ "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"} ] }

Risposta riuscita ( 200 OK )

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

Risposta di errore ( 400 Bad Request oppure 500 Internal Server Error )

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

Le costanti per l’API si impostano in ScaleMonitor nella scheda «API settings». Nella tabella potete inserire una costante API, che corrisponde al nome della costante inviata all’API. Nella colonna «parameter», selezionate il parametro rappresentato dalla costante. I parametri possono essere statici, ad esempio peso lordo e peso netto, oppure dinamici, come i parametri aggiuntivi definiti dall’utente, ad esempio LOT o codice articolo.

5.3. Importare voci del database tramite API Endpoint

POST /Api/DynamicEntityList/DynamicEntityListApi/insertDatabaseValue/

Descrizione

Importa righe nel database desiderato.

Richiesta

Intestazioni

Parametri POST (JSON BODY)

Un oggetto JSON il cui nome è il codice del database. L’oggetto contiene un array di righe del database; ogni riga utilizza il codice del parametro come nome e il valore come contenuto.

Non esiste un limite al numero di righe e di database che si possono inserire contemporaneamente.

Esempio di richiesta

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

Risposta

Risposta riuscita

{ "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. Come ottenere l’ID della bilancia

Gli ID delle bilance sono riportati in ogni applicazione ScaleMonitor per le rispettive bilance. Il menu a discesa con l’ID della bilancia si apre facendo clic sul pulsante delle informazioni, un cerchio con la lettera «i».

7. Test dell’API

Per i test si consiglia un software come ARC (Advanced rest client).

Per eseguire il test, inserite l’URL, le informazioni delle intestazioni, l’autorizzazione e il corpo della richiesta.

Dopo aver inserito tutte le informazioni richieste, potete inviare i dati e ricevere una risposta, verificando così la validità della risposta e dei dati.