Scale Monitor REST API

1. Introduction

L’API REST Scale Monitor permet d’intégrer Scale Monitor à vos systèmes et propose des options flexibles adaptées à vos besoins d’échange de données. Vous pouvez récupérer des données depuis Scale Monitor ou recevoir les données de pesage directement dans votre système.

1.1. Options d’intégration

Votre système appelle l’API Scale Monitor

• Récupérez les données de pesage en temps réel ou historiques directement depuis la plateforme Scale Monitor. • Accédez à des données de pesage adaptées à vos besoins opérationnels. • Utilisez les capacités de traitement et de stockage des données de Scale Monitor pour simplifier vos processus.

Scale Monitor envoie les données de pesage à votre API REST

• Configurez Scale Monitor pour envoyer les données de pesage en temps réel directement à votre service web. • Adaptez les déclencheurs et les formats d’envoi à vos systèmes existants. • Gardez la maîtrise de la réception et du traitement des données dans votre infrastructure.

Votre système enregistre les pesées dans ScaleMonitor via l’API REST

• Permet d’enregistrer les pesées de votre système dans le cloud ScaleMonitor.

1.2. Principaux avantages

• Flexibilité : choisissez la méthode d’intégration la mieux adaptée à votre fonctionnement. • Communication en temps réel : partagez instantanément les données entre Scale Monitor et vos systèmes. • Personnalisation : adaptez les formats de données, les déclencheurs et les processus à votre activité. • Compatibilité : fonctionne avec toute balance ou tout dispositif de pesage, quel que soit le fabricant.

1.3. Cas d’utilisation• Synchronisez automatiquement les données de pesage avec les systèmes ERP, WMS ou LIMS. • Recevez des notifications et des mises à jour des données en temps réel pour un suivi précis. • Simplifiez les processus complexes grâce au partage et à la synchronisation automatiques des données.

4. Jetons API

L’API REST ScaleMonitor utilise des jetons JWT standard fournis sur demande. Le jeton doit être envoyé avec la requête dans un en-tête Authorization de type Bearer.

5. Méthodes de l’API 5.1. Récupérer les pesées

Point de terminaison

POST /Api/ScaleMonitor/ScaleMonitorApi/getWeighings/

Description

Récupère la liste des pesées Scale Monitor selon les filtres fournis.

Requête

En-têtes

Paramètres POST (JSON BODY)

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

Réponse

Réponse réussie ( 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 }

Réponse d’erreur ( 400 Bad Request ou 500 Internal Server Error )

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

Point de terminaison

POST /Api/ScaleMonitor/ScaleMonitorApi/saveWeighing/

Description

Enregistre une pesée dans la base de données ScaleMonitor.

Requête

En-têtes

Paramètres POST (JSON BODY)

Exemple de requête

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

Réponse réussie ( 200 OK )

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

Réponse d’erreur ( 400 Bad Request ou 500 Internal Server Error )

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

Les constantes de l’API se configurent dans ScaleMonitor, sous l’onglet « API settings ». Vous pouvez saisir dans le tableau une constante API correspondant au nom de la constante envoyée à l’API. Dans la colonne « parameter », sélectionnez le paramètre représenté par cette constante. Les paramètres peuvent être statiques, par exemple le poids brut ou le poids net, ou dynamiques, comme les paramètres supplémentaires que vous définissez vous-même, par exemple LOT ou le code article.

5.3. Importer des entrées de base de données via l’API Point de terminaison

POST /Api/DynamicEntityList/DynamicEntityListApi/insertDatabaseValue/

Description

Importe des lignes dans la base de données souhaitée.

Requête

En-têtes

Paramètres POST (JSON BODY)

Un objet JSON dont le nom est le code de la base de données. Il contient un tableau de lignes de base de données ; chaque ligne utilise le code du paramètre comme nom et sa valeur comme contenu.

Le nombre de lignes et de bases de données pouvant être insérées simultanément n’est pas limité.

Exemple de requête

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

Réponse

Réponse réussie

{ "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. Comment obtenir l’ID de la balance

Les ID des balances figurent dans chaque application ScaleMonitor pour les balances correspondantes. Le menu déroulant contenant l’ID de la balance s’ouvre en cliquant sur le bouton d’information, un cercle avec la lettre « i ».

7. Tester l’API

Pour les tests, il est recommandé d’utiliser un logiciel tel qu’ARC (Advanced rest client).

Vous pouvez effectuer un test en saisissant l’URL, les informations d’en-tête, les données d’autorisation et le corps de la requête.

Une fois toutes les informations requises saisies, les données peuvent être envoyées. La réponse reçue permet ensuite à l’utilisateur de vérifier la validité de la réponse et des données.