{"info":{"_postman_id":"bc052cb7-c189-464d-2d59-0802dd500510","name":"Qivivo API","description":"

Welcome on the Qivivo API.

Protocol

The Qivivo API use the OAuth2 security protocol. To learn more about the OAuth2 security protocol, you can read the RFC here : https://tools.ietf.org/html/rfc6749.

Developer account

TL;DR : https://account.qivivo.com/

To use the Qivivo API, you will need to access your Qivivo developer account. This account is accessible with the same credentials you use to connect to your thermostat on http://www.qivivo.com/login. This developer account is accessible from the link https://account.qivivo.com/.

Register a new application

To generate your CLIENT_ID and SECRET_ID, you need to provide the following informations:

Name of the application : The name you want the users identify you to. (e.g. Qivivo)

The Redirect URI : This is the URI we will return the access token to. (e.g. https://qivivo.com/authorize)

After that, you will be able to generate an access_token from your credentials.

Get an access_token

To request an access_token, you will need the following information:

Authorization url : https://account.qivivo.com

Access Token URL : https://account.qivivo.com/oauth/token

client_id : YOUR_CLIENT_ID (e.g. GxfReSkJ6g9cCWLpX4oyMizvxGyCwsKblSd3iGJf)

client_secret : YOUR_CLIENT_SECRET (e.g. vHySmiL4fJ4RDxaC3ss9M5QqjiKxc4rEhTlIVP6SzZEaSp2V2h)

scope : List of your desired scope (e.g. user_basic_information read_devices read_thermostats read_wireless_modules read_programmation update_programmation read_house_data update_house_settings)

grant_type : authorization_code | client_credential | refresh_token

NOTES:

Tokens are valid 3600 seconds
\n
Scope is required for client credential authentication
\n

Limitation

Currently, the number of calls to the API is limited to 1000 calls per hour per client. This limitation will be reviewed to distinguish end user and client.

An HTTP error code 429 is returned if this limit is reached.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1147709","collectionId":"bc052cb7-c189-464d-2d59-0802dd500510","publishedId":"2MsDNL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-10-13T08:30:10.000Z"},"item":[{"name":"Absence","item":[{"name":"https://data.qivivo.com/api/v2/devices/thermostats/:thermostat_uuid/absence","id":"d64f1f8b-f8e9-6470-50d5-980393886046","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer rEjmf4MVFzNQIC9RP8kuAzHFo1xwfQ"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"2017-07-01 10:00\",\n \"end_date\": \"2017-08-31 22:00\"\n}"},"url":"https://data.qivivo.com/api/v2/devices/thermostats/5dcb767f-d652-446a-a7d4-c8b22f77a7e8/absence","description":"

Scope

update_programmation

Description

Set an absence periode.

Parameters

The format of start_date and end_date follow the ISO8601 specification : year-month-day hour:minute. (e.g. \"11:09 dec. 10th, 2013\" will be \"2013-12-10 11:09\")

\n","urlObject":{"protocol":"https","path":["api","v2","devices","thermostats","5dcb767f-d652-446a-a7d4-c8b22f77a7e8","absence"],"host":["data","qivivo","com"],"query":[],"variable":[]}},"response":[{"id":"460c2959-b532-eeb7-5367-3acf7260b199","name":"post absence","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer rEjmf4MVFzNQIC9RP8kuAzHFo1xwfQ","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true,"description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"2017-07-01 10:00\",\n \"end_date\": \"2017-08-31 22:00\"\n}"},"url":"https://data.qivivo.com/api/v2/devices/thermostats/5dcb767f-d652-446a-a7d4-c8b22f77a7e8/absence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Connection","key":"Connection","value":"close","description":""},{"name":"Content-Length","key":"Content-Length","value":"121","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Tue, 07 Feb 2017 11:18:46 GMT","description":""},{"name":"Server","key":"Server","value":"Apache","description":""}],"cookie":[],"responseTime":"289","body":"{\n \"details\": \"This will be effective with the next transmission\", \n \"message\": \"The absence period has been created\"\n}"}],"_postman_id":"d64f1f8b-f8e9-6470-50d5-980393886046"},{"name":"https://data.qivivo.com/api/v2/devices/thermostats/:thermostat_uuid/absence","id":"c3de18f1-2ea4-d0f8-9db2-3fbd47f06bf3","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer rEjmf4MVFzNQIC9RP8kuAzHFo1xwfQ"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://data.qivivo.com/api/v2/devices/thermostats/5dcb767f-d652-446a-a7d4-c8b22f77a7e8/absence","description":"

Scope

update_programmation

Description

Cancel an absence periode. The thermostat will go back to its regular behaviors and will follow the programmation set.

\n","urlObject":{"protocol":"https","path":["api","v2","devices","thermostats","5dcb767f-d652-446a-a7d4-c8b22f77a7e8","absence"],"host":["data","qivivo","com"],"query":[],"variable":[]}},"response":[{"id":"f5ebb51c-8a75-c13a-1b57-8adf332e5f21","name":"cancel absence","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer rEjmf4MVFzNQIC9RP8kuAzHFo1xwfQ"},{"key":"Content-Type","value":"application/json","enabled":true,"description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"https://data.qivivo.com/api/v2/devices/thermostats/5dcb767f-d652-446a-a7d4-c8b22f77a7e8/absence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Connection","key":"Connection","value":"close","description":""},{"name":"Content-Length","key":"Content-Length","value":"122","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Tue, 07 Feb 2017 11:19:49 GMT","description":""},{"name":"Server","key":"Server","value":"Apache","description":""}],"cookie":[],"responseTime":"319","body":"{\n \"details\": \"This will be effective with the next transmission\", \n \"message\": \"The absence period has been canceled\"\n}"}],"_postman_id":"c3de18f1-2ea4-d0f8-9db2-3fbd47f06bf3"}],"id":"d0d4f64a-7537-e27c-2511-84f34ca34681","description":"

The Absence Mode allows the heater to use the frost temperature while the user is away.

An absence period can end on three different event:

The absence end_date is over
The absence is canceled
A presence is detected in the house

\n","urlObject":{"protocol":"https","path":["api","v2","devices","thermostats","5dcb767f-d652-446a-a7d4-c8b22f77a7e8","temperature","temporary-instruction"],"host":["data","qivivo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"db69e374-0c91-5bd6-de2f-3931d79cca68"},{"name":"https://data.qivivo.com/api/v2/devices/thermostats/:thermostat_uuid/temperature/mode/heat/raise","id":"278fbc67-021a-4bc8-96d8-f7b274a07e5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://data.qivivo.com/api/v2/devices/thermostats/047a6172-7714-48f9-a75c-b8a243cf4767/temperature/mode/heat/raise","description":"

This route mimic the same behavior than the + button on the thermostat.

\n","urlObject":{"protocol":"https","path":["api","v2","devices","thermostats","047a6172-7714-48f9-a75c-b8a243cf4767","temperature","mode","heat","raise"],"host":["data","qivivo","com"],"query":[],"variable":[]}},"response":[{"id":"3e4409ab-66b9-409e-8a23-41934f618ad5","name":"https://data.qivivo.com/api/v2/devices/thermostats/:thermostat_uuid/temperature/mode/heat/raise","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://data.qivivo.com/api/v2/devices/thermostats/047a6172-7714-48f9-a75c-b8a243cf4767/temperature/mode/heat/raise"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Mar 2019 03:29:31 GMT"},{"key":"Server","value":"Apache"},{"key":"Content-Length","value":"75"},{"key":"Keep-Alive","value":"timeout=30, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": null,\n \"message\": \"The request for heating has been set\"\n}"}],"_postman_id":"278fbc67-021a-4bc8-96d8-f7b274a07e5e"},{"name":"https://data.qivivo.com/api/v2/devices/thermostats/:thermostat_uuid/temperature/mode/heat/decrease","id":"412de127-bc7d-4e9f-9614-7c919ef34eeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://data.qivivo.com/api/v2/devices/thermostats/047a6172-7714-48f9-a75c-b8a243cf4767/temperature/mode/heat/decrease","description":"

Set current wireless module to thermostat zone

\n","urlObject":{"protocol":"https","path":["api","v2","devices","wireless-modules","f25c6930-6b7e-401b-a672-c95e2aaaebb2","program","thermostat-zone"],"host":["data","qivivo","com"],"query":[],"variable":[]}},"response":[{"id":"3965ba79-473c-c190-e4d3-265ad322d85e","name":"success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","enabled":true,"description":"The mime type of this content"},{"key":"Authorization","type":"text","name":"Authorization","value":"Bearer 2onZI9UvDkqaqJEaFs34t3Wn7ZNs68"}],"body":{"mode":"raw","raw":""},"url":"https://data.qivivo.com/api/v2/devices/wireless-modules/f25c6930-6b7e-401b-a672-c95e2aaaebb2/program/thermostat-zone"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Connection","key":"Connection","value":"close","description":""},{"name":"Content-Length","key":"Content-Length","value":"80","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json","description":""},{"name":"Date","key":"Date","value":"Mon, 13 Feb 2017 15:00:45 GMT","description":""},{"name":"Server","key":"Server","value":"Apache","description":""}],"cookie":[],"responseTime":"145","body":"{\n \"details\": null, \n \"message\": \"The program has been successfully changed\"\n}"}],"_postman_id":"7a851c29-356c-f7cc-2f58-a2c95ac38a7f"}],"id":"ffb795bc-e3a6-acf6-ea2d-0ab11f219a1d","_postman_id":"ffb795bc-e3a6-acf6-ea2d-0ab11f219a1d","description":""},{"name":"_Errors","item":[],"id":"a0be8db4-22cd-83d9-9a76-2f31c685abc3","description":"

In case of mission parameters, the API return a 400 error with a JSON object following this pattern:

{\n  \"details\": \"The following parameter is missing: temperature_setting_name\",\n  \"message\": \"There is an error in the request\"\n}\n

","_postman_id":"a0be8db4-22cd-83d9-9a76-2f31c685abc3"},{"name":"_Scopes","item":[],"id":"d13621eb-b38f-ff62-ece8-b37bf9a4faca","description":"

The following scopes are allowed:

user_basic_information read_devices read_thermostats read_wireless_modules read_programmation update_programmation read_house_data update_house_settings

In order to user several scope, please use a space between them. (e.g. scope = \"read_devices read_programmation\")

\n","_postman_id":"d13621eb-b38f-ff62-ece8-b37bf9a4faca"},{"name":"_Supported grant types","item":[{"name":"https://account.qivivo.com/oauth/token?grant_type=refresh_token&refresh_token=REFRESH_TOKEN&client_id=CLIENT_ID","id":"495f7c97-cbb0-b3be-2775-343aca0f3585","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://account.qivivo.com/oauth/token?grant_type=refresh_token&refresh_token=X1A7t6lxLCdatqnwf3El2rb1PTPBjW","description":"

Refresh token

Use this method to get a new access token from a refresh token.

\n","urlObject":{"protocol":"http","path":["oauth","token"],"host":["account","qivivo","com"],"query":[{"key":"grant_type","value":"refresh_token"},{"key":"refresh_token","value":"X1A7t6lxLCdatqnwf3El2rb1PTPBjW"},{"disabled":true,"key":"client_id","value":"Gtrhqsi7N32pSwvtpwlj61VFKkvoezlf2OgYoQH4"}],"variable":[]}},"response":[],"_postman_id":"495f7c97-cbb0-b3be-2775-343aca0f3585"}],"id":"0f0541b3-b539-e7cb-b1ad-a13417da7c19","description":"

authorization_code: The Authorization Code grant type is used when the client wants to request access to protected resources on behalf of another user (i.e. a 3rd party). This is the grant type most often associated with OAuth.
client_credentials: The Client Credentials grant type is used when the client is requesting access to protected resources under its control (i.e. there is no third party).
refresh_token: The Refresh Token grant type is used to obtain additional access tokens in order to prolong the client’s authorization of a user’s resources.

\n","_postman_id":"0f0541b3-b539-e7cb-b1ad-a13417da7c19"}]}