BEDIENUNGSANLEITUNG · v1.4 · DEUTSCH
Scale Monitor REST API
Bedienungsanleitung und Konfiguration
1. Einleitung
Der Scale Monitor REST API ermöglicht eine nahtlose Integration zwischen Scale Monitor und Ihren Systemen und bietet flexible Optionen für Ihren Datenaustausch. Egal, ob Sie Daten von Scale Monitor abrufen oder Wägedaten direkt in Ihr System erhalten möchten, wir haben Sie abgedeckt.
1.1. Integrationsmöglichkeiten
Ihr System ruft den Scale Monitor API auf
- Abrufen von Echtzeit- oder historischen Wägedaten direkt von der Plattform von Scale Monitor. • Zugriff auf vollständig angepasste Wägedaten, die auf Ihre betrieblichen Anforderungen zugeschnitten sind. • Nutzen Sie die robusten Datenverarbeitungs- und Speicherfunktionen von Scale Monitor, um Ihre Arbeitsabläufe zu vereinfachen.
Scale Monitor sendet Wägedaten an Ihren REST API
- Konfigurieren Sie Scale Monitor, um Echtzeit-Wägedaten direkt in Ihren Webservice zu übertragen. • Passen Sie Datenauslöser und Lieferformate an, um sie nahtlos in Ihre bestehenden Systeme zu integrieren. • Behalten Sie die vollständige Kontrolle darüber, wie Daten in Ihrer Infrastruktur empfangen und verarbeitet werden.
Ihr System speichert Wägungen in Scale Monitor über REST API
- Ermöglicht das Speichern von Wägungen in der Scale Monitor-Cloud von Ihrem System aus.
1.2. Wesentliche Vorteile
- Flexibilität: Wählen Sie die Integrationsmethode, die am besten zu Ihrem Betriebsmodell passt. • Echtzeitkommunikation: Ermöglichen Sie den sofortigen Datenaustausch zwischen Scale Monitor und Ihren Systemen. • Anpassung: Passen Sie Datenformate, Trigger und Workflows an Ihre Geschäftsprozesse an. • Cross-Compatibility: Funktioniert mit jeder Waage oder Wägevorrichtung, unabhängig vom Hersteller.
1.3. Anwendungsfälle• Automatische Synchronisierung der Wägedaten mit ERP-, WMS- oder LIMS-Systemen. • Erhalten Sie Benachrichtigungen und Datenaktualisierungen in Echtzeit für eine präzise Überwachung. • Vereinfachen Sie komplexe Workflows mit automatisiertem Datenaustausch und Synchronisierung.
Originalseite ansehen 3 — Diagramme und Layout
Originalseite ansehen 4 — Diagramme und Layout
Originalseite ansehen 5 — Diagramme und Layout
Originalseite ansehen 6 — Diagramme und Layout
| Code | Ursache |
|---|---|
| 200 - Erfolg | Erfolgreiche Antwort |
| 400 - Schlechte Anfrage | Ungültige Parameter oder Fehler |
| 401 - Nicht autorisiert | Ungültige Authentifizierungsdaten |
| 403 - Verboten | Ungültige Berechtigungen |
| 404 - Nicht gefunden | Endpunkt existiert nicht |
4. API-Token
Scale Monitor REST API verwendet Standard-JWT-Token, die auf Anfrage zur Verfügung gestellt werden.
5. API-Verfahren 5.1 Wiegen abholen
Endpunkt
POST /Api/ScaleMonitor/ScaleMonitorApi/getWeighings/
Beschreibung
Ruft eine Liste der Waagenwägungen ab, die auf den bereitgestellten Filtern basieren.
Antrag
Kopfzeilen
| Kopfzeile | Wert |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR ACCESS TOKEN |
POST-Parameter (JSON BODY)
| Parameter | Typ | Beschreibung |
|---|---|---|
| dateTimeFrom | string (YYYY-MM-DD HH:mm:ss) | Filter für das Anfangsdatum des Wiegens |
| dateTimeTo | string (YYYY-MM-DD HH:mm:ss) | Enddatumsfilter für das Wiegen |
| weighingNumber | int | Spezifische Wägenummer |
| weighingNumberFrom | int | Startbereich für Wägenummern |
| weighingNumberTo | int | Endbereich für Wägenummern |
| scaleInventoryNumber | string | Inventarnummer der Waage |
| scaleTitle | string | Sucht skalierbare Titel für diese Substring |
| scaleUuid | string | Spezifische Kennung der Waage |
| scaleId | int | ID der Waage |
Originalseite ansehen 7 — Diagramme und Layout
{ "dateTimeFrom": "2025-03-01", "dateTimeTo": "2025-03-25", "scaleId": 123 }
Antwort
Erfolgsreaktion ()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 }
Fehlerantwort ()400 Bad Requestoder500 Internal Server Error )
{ "error": 1, "errorMessage": "Failed getting weighings: Internal server error" }
Originalseite ansehen 8 — Diagramme und Layout
Endpunkt
POST /Api/ScaleMonitor/ScaleMonitorApi/saveWeighing/
Beschreibung
Speichern Sie das Wiegen in der Scale Monitor-Datenbank.
Antrag
Kopfzeilen
| Kopfzeile | Wert |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR ACCESS TOKEN |
POST-Parameter (JSON BODY)
| Parameter | Typ | Beschreibung |
|---|---|---|
| scaleId | int | ID der Waage |
| checkForDuplicates | int | Wird vor dem Speichern geprüft, ob das Wiegen mit den angegebenen Daten bereits vorhanden? |
| constantForDuplicate | string | Konstante, die überprüft wird, ob das Wiegen vorhanden ist. |
| duplicateValueCheck | string | Wert, der überprüft wird, um zu sehen, ob die Wiegen existiert. |
| Parameter | List | Eine Liste von Parametern mit einer Konstante und den Wert. |
Beispielantrag
{ "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"} ] }
Originalseite ansehen 9 — Diagramme und Layout
Erfolgsreaktion ()200 OK )
{ "data": { "text": "Weighing saved successfully", "weighingNumber": 253, "duplicateValueCheck": "", "weighingAdded": true }, "error": 0 }
Fehlerantwort ()400 Bad Requestoder500 Internal Server Error )
{ "error": 1, "errorMessage": "Failed while saving weighing: E:Error while retrieving ScaleMonitor data }
Konstanten für den API werden in Scale Monitor unter der Registerkarte 'API-Einstellungen' gesetzt. In der Tabelle selbst haben Sie die Option, eine API-Konstante einzugeben, die den Namen der Konstanten darstellt, die Sie an den API senden. In der Spalte 'Parameter' wählen Sie den Parameter aus, den diese Konstante darstellen wird. Parameter können statisch sein (z. B. Bruttogewicht, Nettogewicht ...) oder dynamisch, wie zusätzliche Parameter (z. B. LOT, Artikelcode), die Sie selbst definieren.
Originalseite ansehen 10 — Diagramme und Layout
5.3 Importieren von Datenbankeinträgen mit API Endpunkt
POST /Api/DynamicEntityList/DynamicEntityListApi/insertDatabaseValue/
Beschreibung
Importiert Datenbankzeilen in die gewünschte Datenbank.
Antrag
Kopfzeilen
| Kopfzeile | Wert |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR ACCESS TOKEN |
POST-Parameter (JSON BODY)
Ein JSON-Objekt, dessen Schlüssel der Datenbankcode ist. Es enthält ein Array mit Datenbankzeilen. In jeder Zeile dient der Parametercode als Schlüssel und der zugehörige Wert als Inhalt.
Es gibt keine Begrenzung für die Anzahl der Zeilen und Datenbanken, die auf einmal eingefügt werden können.
Beispielantrag
{ "Products": [ { "ID": "2025001", "Title": "Screw" }, { "ID": "2025002", "Title": "Bolt" } ] }
Antwort
Erfolgsmeldung
{ "msg": "Database values have been inserted successfully!", "error": 0 }
Originalseite ansehen 11 — Diagramme und Layout
{ "error": 1 "errorMessage": "Error inserting database values: Attribute has not been found!Internal server error" }
6. Wie man die Waagen-ID erhält
Scale-IDs werden auf jede Scale Monitor-Anwendung für ihre jeweilige Waage geschrieben. Das Dropdown-Menü mit der Waage ID kann durch Klicken auf den Info-Button (Kreis mit "i") aufgerufen werden.
7. Prüfung von API
Zum Testen wird empfohlen, eine Software wie ARC (Advanced Rest Client) zu verwenden.
Das Testen kann durch Eingabe der URL, der Header-Informationen, der Autorisierung und des Körpers erfolgen.
Originalseite ansehen 12 — Diagramme und Layout
Nachdem alle erforderlichen Informationen eingegeben wurden, können die Daten gesendet werden und es wird eine Antwort erhalten, in der der Benutzer die Gültigkeit der Antwort / der Daten bestätigen kann.
Originalseite ansehen 13 — Diagramme und Layout
Brauchen Sie Hilfe?
Benötigen Sie Hilfe bei Software, Konnektivität oder der Verwendung einer Lösung? Beschreiben Sie das Problem, damit wir beim nächsten Schritt helfen können.