API for Developers

REST API Documentation

Authorization

In this section you will find the handshake process (permissions and justifications) for the authorization of an external application to work along with IntesisHome.


First you need a justification.


Let us known what your service want to offer to improve our users experience. Please, use our contact form to get in touch with us and tell us a bit more about your idea.

Our web authorization process works on OAuth2


Authorization OAuth2 process

Methods

Find below the different methods available to interact with our devices and services.


getConfiguration

Array of installations: Available installations for "account_token" user.

installation_id "xsnd34d24sopn"
name "My installation"
devices <array of Devices object>

Array of devices: Available devices for each installation.

device_id "jdhd749Gn7H"
locale "en-US"
is_online TRUE
services <array of Services object>

Array of services: Available services for each device.

service_id com.intesishome.power
has_read TRUE
has_write TRUE
format bool
value TRUE
service_id com.intesishome.wifi-signal
has_read TRUE
has_write FALSE
format string
value "goog"
available_values “unknown", “disconnected", “low", “good", "excellent"
service_id com.intesishome.unit-error
has_read TRUE
has_write FALSE
format bool
value TRUE
code “E67"
description “text error"
service_id com.intesishome.user-mode
has_read TRUE
has_write TRUE
format string
value "cool"
available_values “heat", “cool", “auto", “dry", "fan"
service_id com.intesishome.fan-speed
has_read TRUE
has_write TRUE
format string
value "auto"
available_values "auto", “position-one", “position-two”
service_id com.intesishome.setpoint-temp
has_read TRUE
has_write TRUE
format float
value 21.5
max_value 32.0
min_value 16.0
step 0.5
service_id com.intesishome.current-temp
has_read TRUE
has_write FALSE
format float
value 21.5
service_id com.intesishome.vertical-vanes
has_read TRUE
has_write TRUE
format string
value "swing"
available_values "auto", “position-one", “position-two”
service_id com.intesishome.horizontal-vanes
has_read TRUE
has_write TRUE
format string
value "swing"
available_values "auto", “position-one", “position-two”

Example of "ad_information"



          

getValues

This method returns the current status value for each requested service - device.

Parameters of GET method:

account_token <<Provided authorization token>>
ad_information JSON array of devices & services


          

Example of the IntesisHome API response



          

setValues

This method performs a value update on specified service - device.

POST method parameters:

account_token <<Provided authorization token>>
ad_information JSON array of devices & services

Example of "ad_information"



        

Real Time Update (Notifications)

In addition to getValues and setValues methods implemented in our API, we offer the option to call third party API to provide real time value changes.

For example, if the current temperature of a known device changes, we can notify a setValues POST method to your server (with the same format than setValues method implemented in our API).

This feature is optional and intended to decrease the polling getValues requests.

Public API Terms of Use

By using the Public API, you agree to the terms below. If you disagree with any of these terms, IntesisHome does not grant you a license to use the Public API. We reserve the right to update and change these terms from time to time without notice. You can always find the most recent version of these terms here: https://www.intesishome.com/developers/api-terms/.