Overview

enVision Cloud provides a set of endpoints that enable authorized parties to download information on registered devices.

You must include a valid Bearer token in the Authorization header of any request to enVision Cloud APIs. Tokens can be managed in the enVision Cloud Portal

Response Format

All calls to Device APIs return single or multiple device records.

Example Response

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "My enVision Device",
    "appVersion": "v1.2",
    "terminalId": 3,
    "lastHeartbeatUtc": "2024-08-01T18:40:40.354Z",
    "registrationCode": "ABCD2345"
  }
]

Property	Data Type	Description
id	string	enVision System-assigned unique identifier for the device. Use it as input for endpoints that accept a `deviceClientId`
name	string	Name of the device
appVersion	string	Application Version the device is running
terminalId	string	the Id of the terminal the device is associated with
lastHeartbeatUtc	string	UTC Date & time of last heartbeat received
registrationCode	string	Device Registration Code

Endpoints

All Devices

Returns an array containing available devices

/api/deviceclients

Example Request

curl "https://api.ece.phdsolutions.ca/api/deviceClients" \
-X GET \
-H "Authorization: Bearer YOUR_AUTH_TOKEN"

Request Parameters

None.

Device by Id

Returns the device specified by the ID parameter, or 404 if not found.

/api/transactions/deviceclients/{id}

Example Request

curl "https://api.ece.phdsolutions.ca/api/deviceClients/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
-X GET \
-H "Authorization: Bearer YOUR_AUTH_TOKEN"

Request Parameters

Parameter	Required	Description
id	Yes	The terminalId of the request.

Terminals

API endpoints for retrieving Terminals

Transactions

API endpoints for retrieving Transactions from enVision Cloud