Overview
Accessing the Device API
The enVision K150S serves an onboard HTTP API at http://<your-device-ipaddress>/api/v1.
See below for a high-level overview of available API endpoints.
See the integration guide for information on how to determine the IP Address of an enVision K150S device.
Enabling the Device API
By default, the onboard API for the enVision K150S device is disabled. To enable or disable the API for the device access the configuration potal and set the state of the Enable Local API toggle switch. Save the configuration and the enVision K150S device will update.
Example API Request
The /measure endpoint triggers the enVision K150S to execute a single measure operation and return the result.
Example for a device with IP address 192.168.1.191:
curl -i "http://192.168.1.191/api/v1/measure" \
-X GET
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 24 Feb 2025 20:43:50 GMT
Server: Kestrel
Transfer-Encoding: chunked
api-supported-versions: 1.0
{
"transactionReference": null,
"customReference1": null,
"customReference2": null,
"customReference3": null,
"imageIdentifier": "00000000-0000-0000-0000-000000000000",
"elapsedMs": 1234,
"dateTimeLocal": "2025-02-24T15:41:24.3898755-05:00",
"dateTimeUtc": "2025-02-24T20:41:24.3898755Z",
"errorCode": 0,
"errorMessage": "-",
"objectCount": 1,
"dimsUnitOfMeasure": "cm",
"weightUnitOfMeasure": "lb",
"measurementFidelity": "0.5",
"legalForTrade": false,
"weight": 24.00,
"objectId": "",
"measuredObjects": [
{
"trackId": 0,
"errorCode": 0,
"errorMessage": "-",
"rotationAngle": 12.3,
"length": 10.3,
"width": 12.1,
"height": 14.5
}
]
}
API Endpoints
Consult the individual pages below for details on the api contract for all available endpoints.
- Ping acts as a health-check endpoint.
- Measure provides an endpoint to trigger the device to measure.
- Images a collection of endpoints provided to extract images captured by cameras onboard the enVision K150S.
- Error Codes a collection of error codes returned upon triggering the device measuring