We Value Your Privacy
By clicking "Accept", you agree to our use of cookies to improve your experience, analyze site usage, and deliver personalized contents.
Open API Interface
Instruction
iHost offers a set of open API documents for you to develop your add-on or integrate iHost into the third-party home automation system. iHost is fully under the control to obtain device information and control the device by calling an HTTP API request.
Start to Use
Preparation
Step 1. Please make sure the gateway is powered on and works properly.
The BLUE indicator is a normal network connection.The RED indicator is an abnormal network connection.
Step 2. Make sure the gateway and the PC are connected to the same LAN. Then enter the URL http://ihost.local on your browser.
Notice:
If you have several gateways, you can get the corresponding IP address to access the specified gateway in the below two ways.
- Log in to your wireless router and check the IP address of the gateway in DHCP.
- iHost supports local discovery via mDNS.
Get started
Preparation
- Call the [Access Token] interface, and get an error response, prompting to click <Done>.
Note that after pressing, the interface access is valid for no more than 5 minutes.
// Request curl --location --request GET 'http://<ip address>/open-api/v1/rest/bridge/access_token' --header 'Content-Type: application/json'
// Response { "error": 401, "data": {}, "message": "link button not pressed" }
- Click <Done> and call the [Access Token] interface again. The response is successful, and the token is obtained.
// Request
curl --location --request GET 'http://<ip address>/open-api/v1/rest/bridge/access_token' --header 'Content-Type: application/json'
// Response
{
"error": 0,
"data": {
"token": "376310da-7adf-4521-b18c-5e0752cfff8d"
},
"message": "success"
}- Verify token. Call the [Get Device List] interface. The response is successful, and the device list is obtained.
// Request
curl --location --request GET 'http://<ip address>/open-api/v1/rest/devices' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 376310da-7adf-4521-b18c-5e0752cfff8d'
// Response
{
"error": 0,
"data": {
"device_list": [
{
"serial_number": "ABCDEFGHIJK",
"name": "device name",
"manufacturer": "manufacturer name",
"model": "model name",
"firmware_version": "1.1.0",
"display_category": "switch",
"capabilities": [
{
"capability": "power",
"permission": "readWrite"
}
],
"protocol": "zigbee",
"state": {
"power": {
"powerState": "on"
}
},
"tags": {
"key": "value"
},
"online": true
}
]
}
"message": "success"
}Get iHost access token method: After calling the [Access Token] interface, the iHost Web console page global pop-up box prompts the user to confirm the acquisition of the interface call credentials.
Note: If you open more than one iHost web console page, the confirmation pop-up box will appear on multiple web console pages together, and the pop-up box of other web console pages will be closed after clicking the confirmation on one of the web console pages.
Hardware Function
Restart Gateway
Allow authorized user to restart the gateway through this interface
- URL?
/open-api/v1/rest/hardware/reboot - Method?
POST - Header?
- Content-Type: application/json
- Autorization: Bearer <token>
Request Parameters: none
Successful data response: empty Object {}
Conditions: The request parameters are legal, and the user identity verification is passed.
Status Code: 200 OK
{
"error": 0,
"data": {},
"message": "success"
}Speaker Control
Allow authorized users to control the speaker through this interface
- URL?
/open-api/v1/rest/hardware/speaker - Method?
POST - Header?
- Content-Type: application/json
- Authorization: Bearer <token>
Request parameters
Attribute | Type | Optional | Description |
type | string | N | Optional parameters: 1.play_sound (play the sound) 2.play_beep (play the beep) |
sound | SoundObject | Y (N if type is play_sound.) | The sound. |
beep | BeepObject | Y (N if type is play_beep.) | The beep |
SoundObject Object
Attribute | Type | Optional | Description |
name | string | N | The sound name. The supported values can be checked in [Resource List – Supported sound] |
volume | int | N | The sound volume. [0-100] |
countdown | int | N | The duration for the speaker to play the sound, and it will stop playing automatically after the time is up. Unit: second. [0,1799] |
Conditions: The request parameters are legal, and the user identity verification is passed.
Status Code:
Status Code:
200 OKBeepObject Object
Attribute | Type | Optional | Description |
name | string | N | The deep name. The supported values can be checked in [Resource List – Supported deep] |
volume | int | N | The deep volume. [0-100] |
Successful data response: empty Object {}
Conditions: The request parameters are legal, and the user identity verification is passed.
Status Code:
Status Code:
200 OKResponse Example:
{
"error": 0,
"data": {},
"message": "success"
}Open API Document
Check the below link to learn more details about WEB API, Third-party Device Access, Server-sent events, and so on.
https://ewelink.cc/ewelink-cube/open-api/
https://ewelink.cc/ewelink-cube/open-api/