The following article demonstrates how to set up an environment within Postman (v11.2.1) for testing Canary's web Read API. Postman is a platform designed for building and using API's. For more information on Postman and where to download it, visit https://www.postman.com/.

DISCLAIMER: The API requests found in this collection are configured to connect to the secure (https) Read API endpoint (55236) within Views on the local machine. The apiToken variable will need updated to reflect the token configured in your system.

Configuration

1. Create a token in the Identity service that will be used for the ApiToken variable in Step 5.

   

2. Open the Postman app and select Collections within the Workspaces page.

   

3. Import the attached CanaryWebReadAPIv24.postman_collection.json and Canary Web Read API v24.postman_environment files.

   

4. Select the Canary Web Read API environment from the drop-down list.

   

5. Open the Environment quick look menu to update the ApiToken variable. This token can be copied from the Identity tile>Security>API Tokens screen in the Canary Admin.

   

   Other variables may need updated depending on your environment.
    
6. To test the connection, select getTagData2_Raw from the V2\POST folder. Select the Body tab to see the JSON message that will be passed in. This call will attempt to retrieve raw data for the Sys.Memory Physical tag in the {Diagnostics} DataSet.

   

7. Press Send. The call should return a Good status with the tag values and timestamps from the past 24 hours.