NAVODILA ZA UPORABO · v1.4 · SLOVENŠČINA
Scale Monitor REST API
Navodila za uporabo in konfiguracijo
1. Uvod
Scale Monitor REST API omogoča nemoteno povezovanje sistema Scale Monitor z vašimi sistemi ter prilagodljive možnosti za izmenjavo podatkov. Omogoča pridobivanje podatkov iz sistema Scale Monitor ali prejemanje podatkov o tehtanju neposredno v vaš sistem.
1.1. Možnosti povezovanja
Vaš sistem kliče Scale Monitor API
- Pridobivajte podatke o tehtanju v realnem času ali zgodovinske podatke neposredno iz platforme Scale Monitor. • Dostopajte do podatkov o tehtanju, povsem prilagojenih vašim operativnim zahtevam. • Z zmogljivostmi sistema Scale Monitor za obdelavo in shranjevanje podatkov poenostavite svoje delovne postopke.
Scale Monitor pošilja podatke o tehtanju v vaš REST API
- Nastavite Scale Monitor za neposredno pošiljanje podatkov o tehtanju v realnem času v vašo spletno storitev. • Prilagodite sprožilce in oblike posredovanja podatkov za nemoteno povezovanje z obstoječimi sistemi. • Ohranite popoln nadzor nad prejemanjem in obdelavo podatkov v svoji infrastrukturi.
Vaš sistem shranjuje tehtanja v ScaleMonitor prek REST API
- Omogoča shranjevanje tehtanj iz vašega sistema v oblak ScaleMonitor.
1.2. Ključne prednosti
- Prilagodljivost: izberite način povezovanja, ki najbolje ustreza vašemu načinu dela. • Komunikacija v realnem času: omogočite takojšnjo izmenjavo podatkov med sistemom Scale Monitor in svojimi sistemi. • Prilagajanje: prilagodite oblike podatkov, sprožilce in delovne postopke svojim poslovnim procesom. • Združljivost: deluje s katero koli tehtnico ali tehtalno napravo, ne glede na proizvajalca.
1.3. Primeri uporabe • Samodejno sinhronizirajte podatke o tehtanju s sistemi ERP, WMS ali LIMS. • Prejemajte obvestila in posodobitve podatkov v realnem času za natančno spremljanje. • Poenostavite zahtevne delovne postopke s samodejno izmenjavo in sinhronizacijo podatkov.
Ogled izvirne strani 3 — diagrami in postavitev
Ogled izvirne strani 4 — diagrami in postavitev
Ogled izvirne strani 5 — diagrami in postavitev
Ogled izvirne strani 6 — diagrami in postavitev
| Koda | Vzrok |
|---|---|
| 200 - Uspešno | Uspešen odziv |
| 400 - Neveljavna zahteva | Neveljavni parametri ali napaka |
| 401 - Nepooblaščeno | Neveljavni podatki za preverjanje pristnosti |
| 403 - Prepovedano | Neveljavna dovoljenja |
| 404 - Ni najdeno | Končna točka ne obstaja |
4. Žetoni API
ScaleMonitor REST API uporablja standardne žetone JWT, ki jih prejmete na zahtevo. Žeton morate poslati skupaj z zahtevo v glavi Authorization s tipom Bearer.
5. Metode API 5.1. Pridobivanje tehtanj
Končna točka
POST /Api/ScaleMonitor/ScaleMonitorApi/getWeighings/
Opis
Pridobi seznam tehtanj v sistemu Scale Monitor na podlagi podanih filtrov.
Zahteva
Glave
| Glava | Vrednost |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR ACCESS TOKEN |
Parametri POST (telo JSON)
| Parameter | Tip | Opis |
|---|---|---|
| dateTimeFrom | string (YYYY-MM-DD HH:mm:ss) | Začetni datum za filtriranje tehtanj |
| dateTimeTo | string (YYYY-MM-DD HH:mm:ss) | Končni datum za filtriranje tehtanj |
| weighingNumber | int | Določena številka tehtanja |
| weighingNumberFrom | int | Začetek razpona številk tehtanj |
| weighingNumberTo | int | Konec razpona številk tehtanj |
| scaleInventoryNumber | string | Inventarna številka tehtnice |
| scaleTitle | string | V nazivih tehtnic išče ta podniz |
| scaleUuid | string | Enolični identifikator tehtnice |
| scaleId | int | ID tehtnice |
Ogled izvirne strani 7 — diagrami in postavitev
{ "dateTimeFrom": "2025-03-01", "dateTimeTo": "2025-03-25", "scaleId": 123 }
Odziv
Uspešen odziv ( 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 }
Odziv z napako ( 400 Bad Request ali 500 Internal Server Error )
{ "error": 1, "errorMessage": "Failed getting weighings: Internal server error" }
Ogled izvirne strani 8 — diagrami in postavitev
Končna točka
POST /Api/ScaleMonitor/ScaleMonitorApi/saveWeighing/
Opis
Shrani tehtanje v podatkovno zbirko ScaleMonitor.
Zahteva
Glave
| Glava | Vrednost |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR ACCESS TOKEN |
Parametri POST (telo JSON)
| Parameter | Tip | Opis |
|---|---|---|
| scaleId | int | ID tehtnice |
| checkForDuplicates | int | Ali se pred shranjevanjem preveri, ali tehtanje s podanimi podatki že obstaja? |
| constantForDuplicate | string | Konstanta, s katero se preveri, ali tehtanje obstaja. |
| duplicateValueCheck | string | Vrednost, s katero se preveri, ali tehtanje obstaja. |
| parametri | List | Seznam parametrov s konstanto in vrednostjo. |
Primer zahteve
{ "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"} ] }
Ogled izvirne strani 9 — diagrami in postavitev
Uspešen odziv ( 200 OK )
{ "data": { "text": "Weighing saved successfully", "weighingNumber": 253, "duplicateValueCheck": "", "weighingAdded": true }, "error": 0 }
Odziv z napako ( 400 Bad Request ali 500 Internal Server Error )
{ "error": 1, "errorMessage": "Failed while saving weighing: E:Error while retrieving ScaleMonitor data }
Konstante za API nastavite v sistemu ScaleMonitor na zavihku 'API settings'. V tabelo lahko vnesete konstanto API, ki določa ime konstante, poslane v API. V stolpcu 'parameter' izberite parameter, ki ga ta konstanta predstavlja. Parametri so lahko statični (npr. bruto masa, neto masa ...) ali dinamični, na primer dodatni parametri (npr. LOT, Article code), ki jih določite sami.
Ogled izvirne strani 10 — diagrami in postavitev
5.3. Uvoz zapisov v podatkovno zbirko prek API Končna točka
POST /Api/DynamicEntityList/DynamicEntityListApi/insertDatabaseValue/
Opis
Uvozi vrstice v izbrano podatkovno zbirko.
Zahteva
Glave
| Glava | Vrednost |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR ACCESS TOKEN |
Parametri POST (telo JSON)
Objekt JSON, katerega ključ je koda podatkovne zbirke. Objekt vsebuje polje vrstic podatkovne zbirke; v vsaki vrstici je ključ koda parametra, vsebina pa njegova vrednost.
Število vrstic in podatkovnih zbirk, v katere lahko hkrati vstavljate podatke, ni omejeno.
Primer zahteve
{ "Products": [ { "ID": "2025001", "Title": "Screw" }, { "ID": "2025002", "Title": "Bolt" } ] }
Odziv
Uspešen odziv
{ "msg": "Database values have been inserted successfully!", "error": 0 }
Ogled izvirne strani 11 — diagrami in postavitev
{ "error": 1 "errorMessage": "Error inserting database values: Attribute has not been found!Internal server error" }
6. Kako pridobiti ID tehtnice
ID posamezne tehtnice je prikazan v vsaki aplikaciji ScaleMonitor. Spustni meni z ID-jem tehtnice odprete s klikom na gumb za informacije (krog s črko “i”).
7. Preizkušanje API
Za preizkušanje priporočamo programsko opremo, kot je ARC (Advanced rest client).
Preizkušanje izvedete z vnosom naslova URL, podatkov o glavi, podatkov za avtorizacijo in telesa zahteve.
Ogled izvirne strani 12 — diagrami in postavitev
Ko vnesete vse zahtevane podatke, jih lahko pošljete in prejmete odziv, v katerem preverite veljavnost odziva oziroma podatkov.
Ogled izvirne strani 13 — diagrami in postavitev
Potrebujete pomoč?
Potrebujete pomoč pri programski opremi, povezovanju ali uporabi rešitve? Opišite težavo, da vam lahko pomagamo pri naslednjem koraku.