Overview

enVision Cloud provides a set of endpoints that enable authorized parties to download information on registered Terminals, which represent groupings of 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 Terminal APIs return single or multiple terminal records.

Example Response

[
  {
    "id": 1,
    "name": "My Main Terminal",
    "reference": "User-provided Reference",
    "addressLine1": "123 Anystreet",
    "addressLine2": null,
    "city": "Anytown",
    "provinceState": "ON",
    "country": "Canada",
    "zipPostalCode": "L0M1V7"
  }
]

Property	Data Type	Description
id	string	enVision System-assigned unique identifier for the terminal. Use it as input for endpoints that accept a `TerminalId`
name	string	Name of the terminal
reference	string	Terminal reference
addressLine1	string	Address Line 1
addressLine2	string	Address Line 2
city	string	city
provinceState	string	province or state
country	string	country
zipPostalCode	string	Zip/Postal Code

Endpoints

All Terminals

Returns an array containing available terminals

/api/terminals

Example Request

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

Request Parameters

None.

Terminal by Id

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

/api/transactions/terminals/{id}

Example Request

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

Request Parameters

Parameter	Required	Description
id	Yes	The deviceId of the request.

Webhooks

Guide to enVision Cloud webhook integration

Devices

API endpoints for retrieving Devices