Connecting an HTTPS device
This document will help you connect to a Zoho IoT application and send payload messages using HTTPS. For this illustration, Postman will be used as the HTTPS client to send messages to the application.
The steps to establish the HTTPS connection and send payload messages are outlined below.
Creating a device instance with HTTPS connectivity
For this illustration, we will create a device called "My HTTPS Device" in the application.
- Access the End Application.
- Select Devices > Devices in the left pane.
- Click Add Device.
- You are provided with four options (or three if this is your first time adding a device). For this illustration, we will focus on two: Add Using Product Gallery (Device) and Add Using Direct API Endpoint.
Add Using Product Gallery (Devices): The Device Product Gallery contains a list of devices with preconfigured datapoint definitions. When you select a device product and create a device instance from it, the predefined datapoint definitions are automatically imported as datapoints for that device.
Add Using Direct API Endpoint: If your device is not available in the Product Gallery, or if you are using a computer or testing a setup, you can add the device using the Direct API Endpoint method. In this approach, datapoints must be created and configured individually.
Add Using Product Gallery (Devices)
- Select Add Using Product Gallery (Devices) and click Next.
- In the device gallery, filter, browse or search for your device product.
- Click on the your desired product. Here, TRB245 is selected.
- Click Import and Proceed.
- Provide the required details in the appropriate fields.Make sure HTTPS is selected as the device connectivity.
Example:Model Type: Create New Model
Model Name: Gateway HTTPS
Name: My HTTPS Device
Description: A test device for HTTPS connection
Device Connectivity: HTTPS
Device Application: Custom Application
Data Interval : 10
Learn more about configuring the device fields. - Click Proceed.
- Click View Device.
You will be redirected the newly added device instance's device information page. You may be asked to choose to use the onboarding assistant. You can click Proceed to use the onboarding assistant for on-screen help; to continue with this illustration, click Close.
Next, go to the Accessing Connection Credentials section to obtain the details required to establish the HTTPS connection.
Add Using Direct API Endpoint
- Select Add Using Direct API Endpoint and click Next.
- Provide the required details in the appropriate fields. Make sure HTTPS is selected as the device connectivity.
Example:
Model Type: Create New Model
Model Name: Endpoint HTTPS
Name: My HTTPS Device
Description: A test device for HTTPS connection
Device Connectivity: HTTPS
Data Interval: 10Learn more about configuring the device fields. - Click Add.
- Click Ok in the device registered successfully popup.
You will be redirected to the device's information page. You may be asked to choose to use the onboarding assistant. You can click Proceed to use the onboarding assistant for on-screen help; to continue with this illustration, click Close.
Next, go to the Accessing Connection Credentials section to obtain the details required to establish the HTTPS connection.
Accessing Connection Credentials
Each registered device has a unique set of connection credentials that can be used to establish a connection.
- In the device information page, Click Actions > Connection Details.
This will display the credentials required to establish connection with the Zoho IoT application.
Now that you have created your device and obtained its connection credentials, you can proceed to the Updating Credentials section. Here, you will use these credentials to establish a secure HTTPS connection with the Zoho IoT application and start sending data.
Updating the Credentials
In this illustration, we will use Postman, a commonly used HTTPS client, to connect and send data. The fields configured in Postman match those required in an HTTPS based device application.
To send messages using an HTTPS POST request, three credentials are required: the Endpoint (1), Authentication Token (2), and Device ID (3). These credentials are used to establish a secure connection with the Zoho IoT application and send messages from the device.
There are two ways to configure credentials for the HTTPS POST function:
- Using URL Parameters
- Using Headers
Using URL Params
If you're using the HTTPS client/device with parameter-based authentication, you can easily include the credentials in the URL as parameters. The URL to be used can be found in the URL Parameter Implementation section, located under the Endpoint Usage tab.
Structure for URL with Parameters:
https://<telemetry_endpoint>/?device_id=<deviceid>&device-token=<authenticationtoken>In Postman,
- Select the POST method.
- In Connection Details, select the Endpoint Usage section.
- Copy Paste URL Param Implementation into the URL field. This will automatically populate the device_id and device_token keys with their corresponding values.
Using Header
If you're using the Header option for authentication, you can input the following values: device_id and device_token from the Endpoints section as headers into the appropriate fields. In this implementation, the strings "device_id" and "device_token" are used as the keys, while their corresponding values are treated as the actual value.
The Endpoint URL is also available and can be included in the request as part of the connection setup. This ensures a complete configuration for successful authentication and communication with the device.
In Postman,
- Select the POST method.
- Copy and paste the Telemetry Endpoint in the URL field.
- Add device_id as a key and the corresponding device_id value from the Header Implementation as its value.
- Add device_token as a key and paste the device_token value from the Header Implementation section as its corresponding key.
Note: Make sure the device_id and device_token strings copied from the application are not included in the value field.
Sending payload using Postman
Once the credentials are updated, you can begin sending the payload to the Zoho IoT application from the HTTPS client/device.
For this illustration, a simple payload of {"temp": 20} is sent as a JSON object (recommended payload format) to the application.
In Postman,
- Select the Body tab under the URL field.
- Select raw and set the format to JSON.
- Enter the payload.
- Click Send. If the credentials are provided correctly, a success message will be displayed.
Viewing the payload in the Application
With the message sent by the client/device, in this illustration through postman, it can be viewed in the application.
To view the sent messages,
- In the device information page, select the Messages tab.
- Toggle to Historic Messages. The received messages will be displayed.
- Use the refresh button to update the list with new messages.
- To view messages in real time, toggle to Live Messages and click Start Listening.
With the messages received, you can parse the values by creating datapoints and then build dashboards to visualize the data.
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Configuring fields: Device products
This document provides a detailed overview of the various fields you will encounter when creating a custom device product in the Zoho IOT application. The field values specified during the configuration of a device product are not permanent ...HTTPS Telemetry Cases
Zoho IoT provides a dedicated endpoint for specific communication needs while using the HTTPS protocol for device connectivity. The typical structure for an endpoint in HTTPS configurations used in Zoho IoT is : https://<app_url>/v1/iot/<endpoint> To ...Adding and managing device and device models
Prerequisite Before proceeding with this document, please ensure you have read the following prerequisite materials to fully understand the concepts discussed here: Understanding Devices Understanding Device Models Understanding Device Products ...Device Action: Connection Credential
Devices configured with MQTT and HTTPS protocols in the application will have connection credentials, enabling them to link real-world devices with the Zoho IOT application. To access the connection credentials, Access the End Application. Select ...Device Action: Reregister
When devices with MQTT or HTTPS connectivity are added to the application, they are also registered, generating a set of credentials. These credentials are used to connect the real-world devices with the Zoho IoT application. A device can be ...
New to Zoho LandingPage?
Zoho LandingPage Resources