API Guide

Overview

Overview of the APIs available on the enVision 100S Device

Accessing the Device API

The onboard device HTTP API is served at http://<your-device-ipaddress>/api. See below for a high-level overview of available API endpoints.

APIs on the enVision 100S are accessible anonymously and require no authorization headers.

See the integration guide for information on how to determine the IP Address of an enVision 100S device.

Example

The /measure endpoint triggers the enVision 100S to execute a single measure operation and return the result.

Example for a device with IP address 192.168.1.191:

Example Request
curl -i "http://192.168.1.191/api/measure" \
-X GET
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"elapsedMilliseconds":646,"dateTimeLocal":"2024-07-25T16:30:45.4432137-04:00","dateTimeUtc":"2024-07-25T20:30:45.4432237Z","errorCode":0,"errorMessage":"(0) - SUCCESS","objectCount":1,"unitOfMeasure":"in","measurementFidelity":0.2,"dimensionsLegalForTrade":true,"imageId":"3e4a14fa-d786-4403-b257-2a39b863e996","depthImage":null,"colorImage":null,"annotatedColorImage":null,"measuredObjects":[{"trackId":119,"errorCode":0,"errorMessage":"(0) - SUCCESS","rotationAngle":33,"length":5.6,"width":4.6,"height":4}]}
You can also do this in a web browser. The JSON output will be displayed the same manner.

API Endpoints

Consult the individual pages below for details on the api contract for all available endpoints.

  • Ping acts as a connectivity test 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 100S.

Copyright © PHD Solutions 2024