Get started

Welcome to CavyIoT API Reference. Here you can reference most of the entities of our application, and how to update, create, retrieve, edit or delete them.

The purpose of this document is to empower hardware and software developers to build innovative IoT applications. This section is to help you understand what happens in the backstage when communicating with CavyIoT, so you can replicate this in your firmware.

API URL

API access can be over HTTP or secure HTTP, HTTPs, using the following endpoint- https://api.cavyiot.com

Get API-KEY

API-Key authenticate requests to CavyIoT. Every request sent to CavyIoT requires a API-key and it is unique for each Device in your account that authorizes requests sent to CavyIoT.

Sample API-KEY- 3JzIfYb1GXh9cFlTB2do

↳ via `GET` method-

To get API-key you need to make a GET call to the following url with parameters userid, password-

https://api.cavyiot.com/device/get-apikey?userid={userid}&password={password}

Example Request-


var link = "https://api.cavyiot.com/device/get-apikey?userid=userid&password=password";
var request = new XMLHttpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/device/get-apikey?userid=userid&password=password"


import requests
x = requests.get('https://api.cavyiot.com/device/get-apikey?userid=userid&password=password')
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";
String userid="Your-userid";
String password="Your-password";
HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/device/get-apikey?userid="+userid+"&"+"password="+password); 
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To get API-key you need to make a POST call to the following url with JSON parameters- userid, password-

https://api.cavyiot.com/device/get-apikey

Example Request-


var link = "https://api.cavyiot.com/device/get-apikey";
var request = new XMLHttpRequest();
var userid = "Your_userid";
var password = "Your_password";
var rbody= {
            "userid":userid,
            "password":password
            };
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://api.cavyiot.com/device/get-apikey" -H "Content-Type: application/json" -d "{\"userid\":\"Your_userid\",\"password\":\"Your_password\"}"


import requests
x = requests.post('https://api.cavyiot.com/device/get-apikey', json={'userid':'Your_userid','password':'Your_password'})
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";
String userid="Your-userid";
String password="Your-password";
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/device/get-apikey"); 
  http.addHeader("Content-Type", "application/json");
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
   rbody="{\"userid\":\""+userid+"\",\"password\":\""+password+"\"}";             
   EspPostMethod(rbody); 
    
}

void loop() {
  // put your main code here, to run repeatedly:

}

QUERY PARAMETERS

Field	Type	Description
userid	String	Your CavyIoT userid
password	String	Your CavyIoT password

Example Response- `application/json`🔗


{
    "code": 200,
    "detail": "success",
    "device_list": [
        {
            "device": "farm",
            "api_key": "3JzIfYb1GXN9cFlTB2do",
            "active_since": "2020-06-25",
            "service_expires": "2021-06-25"
        },
        {
            "device": "Demo",
            "api_key": "5tyIfYb1gu7dcFlTb48x",
            "active_since": "2020-06-30",
            "service_expires": "2020-07-30"
        },
        {
            "device": "Home",
            "api_key": "3JzIfYb1GXN9cFlTB2dL",
            "active_since": "2020-11-05",
            "service_expires": "2020-12-05"
        },
        {
            "device": "industry",
            "api_key": "3JzIfYb1GXN9cFlTB2dM",
            "active_since": "2020-11-15",
            "service_expires": "2020-11-22"
        }
    ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}


{
    "code": 415,
    "detail": "Syntax Error"
}

Get current status of device

This section explains how to get the status data that's reported to CavyIoT Core by devices. You can monitor the status of each connected device and view diagnostic information to troubleshoot issues and determine the current status of a device. You can get current status of device by API call (GET or POST).

To get current status of device you need to make a GET or POST call to the following URL with parameter API key as path-

https://api.cavyiot.com/{api_key}/device/status

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key

Example Request-


var link = "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/device/status";
var request = new XMLHttpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/device/status"


import requests
x = requests.get('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/device/status')
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String api-key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.
HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/"+api-key+"/device/status"); 
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

Example Response- `application/json`


{
    "code": 200,
    "detail": "success",
    "device_status": {
        "timezone": "Asia\/Calcutta",
        "name": "farm",
        "active_since": "2020-06-25",
        "service_expires": "2021-06-25",
        "auto_mode": true,
        "sensors": [
            {
                "name": "temperature",
                "value": 50,
                "unit": "C",
                "lastupdate": {
                    "time": "21:23:26",
                    "date": "2020-12-03"
                }
            },
            {
                "name": "humidity",
                "value": "25",
                "unit": "RH",
                "lastupdate": {
                    "time": "21:23:26",
                    "date": "2020-12-03"
                }
            }
        ],
        "buttons": [
            {
                "index": "0",
                "lable": "LED1",
                "state": "ON",
                "lastupdate": {
                    "time": "21:23:26",
                    "date": "2020-12-03"
                }
            },
            {
                "index": "1",
                "lable": "LED2",
                "state": "OFF",
                "lastupdate": {
                    "time": "02:34:42",
                    "date": "2020-11-27"
                }
            },
            {
                "index": "2",
                "lable": "LED3",
                "state": "OFF",
                "lastupdate": {
                    "time": "02:34:47",
                    "date": "2020-11-27"
                }
            },
            {
                "index": "3",
                "lable": "LED4",
                "state": "ON",
                "lastupdate": {
                    "time": "02:33:25",
                    "date": "2020-11-27"
                }
            }
        ]
    }
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}

Add Device

This endpoint creates a new Device to your IoT Dashboard.

↳ via `GET` method-

To add a single Device to your IoT Dashboard you need to make a GET call to the following URL with parameters userid, password, and device-

https://api.cavyiot.com/device/add?userid={userid}&password={password}&device={device_name}

Example Request-


var link = "https://api.cavyiot.com/device/add?userid=userid&password=password&device=device_name";
var request = new XMLHtpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/device/add?userid=userid&password=password&device=device_name"


import requests
x = requests.get('https://api.cavyiot.com/device/add?userid=userid&password=password&device=device_name')
prit(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String userid= "Your-userid";  //Replace this userid with your own CavyIoT Userid.
String password="Your-password";  //Replace this password with your own CavyIoT Password.
String device_name="Your-Device-name";  //Name of device to be added into your IoT Dashboard

HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/device/add?userid="+userid+"&password="+password+"&device="+device_name); 
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To add Multiple Devices to your IoT Dashboard you need to make a POST call to the following URL with JSON parameters- name, value, and unit-

https://api.cavyiot.com/{api_key}/sensor/add

Example Request-


var link = "https://api.cavyiot.com/device/add";
var request = new XMLHttpRequest();
var rbody= {
            "userid":"Your-userid",
            "password":"Your-password",
            "devices":["device_name1","device_name2"]
            };
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://team.cavyiot.com/device/add" -H "Content-Type: application/json" -d "{\"userid\":\"Your-userid\",\"password\":\"Your-password\",\"devices\":[\"device_name1\",\"device_name2\"]}"


import requests
rbody={"userid":"Your-userid","password":"Your-password","devices":["device_name1","device_name2"]}
x = requests.post('https://api.cavyiot.com/device/add', json=rbody)
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
#include <ArduinoJson.h>
const char* wifissid="Wifi-SSID";
const char* wifipassword="Wifi-Password";
StaticJsonDocument<800> json_body;
String userid= "Your-userid";  //Replace this userid with your own CavyIoT Userid.
String password="Your-password";  //Replace this password with your own CavyIoT Password.
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/device/add"); 
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
    EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
                json_body["userid"]=userid;
                json_body["password"]=password;
                JsonArray devices = json_body.createNestedArray("devices");
                json_body["devices"][0]="device_name1";
                json_body["devices"][1]="device_name2";
   serializeJson(json_body, rbody);
   EspPostMethod(rbody);
      
}

void loop() {
  // put your main code here, to run repeatedly:

}

QUERY PARAMETERS

Field	Type	Description
userid	String	Your CavyIoT userid
password	String	Your CavyIoT password
device	String	Name of Device to be added to your IoT Dashboard

Example Response- `application/json`


{
    "code": 200,
    "detail": "success",
    "added": [
        {
            "device": "device_name1",
            "api_key": "YBoMvLSdEIAqiQGFTh6p"
        },
        {
            "device": "device_name2",
            "api_key": "DUhJXjzbxlPc894SdTGB"
        }
    ]
}


{
    "code": 207,
    "detail": "Partial success",
    "added": [
        {
            "device": "device_name1",
            "api_key": "6kB2SrZOXeYzGMLUdcWg"
        }
    ],
    "discarded": [
        {
            "device": "device_name2",
            "api_key": "6kB2SrZOXeYzGMLUdcWg"
        }
    ]
}


{
    "code": 208,
    "detail": "Devices already in List",
    "discarded": [
        "device_name1",
        "device_name2"
    ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}


{
    "code": 406,
    "detail": "Not Acceptable. Maximum device limit reached out."
}


{
    "code": 415,
    "detail": "Syntax Error"
}

Delete Device

This endpoint deletes a existing Device from your IoT Dashboard.

↳ via `GET` method-

To delete a single Device you need to make a GET call to the following URL with parameters userid, password, and device-

https://api.cavyiot.com/device/delete?userid={userid}&password={password}&device={device_name}

Example Request-


var link = "https://api.cavyiot.com/device/delete?userid=userid&password=password&device=device_name";
var request = new XMLHtpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/device/delete?userid=userid&password=password&device=device_name"


import requests
x = requests.get('https://api.cavyiot.com/device/delete?userid=userid&password=password&device=device_name')
prit(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String userid= "Your-userid";  //Replace this userid with your own CavyIoT Userid.
String password="Your-password";  //Replace this password with your own CavyIoT Password.
String device_name="Your-Device-name";  //Name of device to be added into your IoT Dashboard

HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/device/delete?userid="+userid+"&password="+password+"&device="+device_name); 
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To delete Multiple Devices you need to make a POST call to the following URL with JSON parameters- name, value, and unit-

https://api.cavyiot.com/{api_key}/sensor/add

Example Request-


var link = "https://api.cavyiot.com/device/delete";
var request = new XMLHttpRequest();
var rbody= {
            "userid":"Your-userid",
            "password":"Your-password",
            "devices":["device_name1","device_name2"]
            };
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://team.cavyiot.com/device/delete" -H "Content-Type: application/json" -d "{\"userid\":\"Your-userid\",\"password\":\"Your-password\",\"devices\":[\"device_name1\",\"device_name2\"]}"


import requests
rbody={"userid":"Your-userid","password":"Your-password","devices":["device_name1","device_name2"]}
x = requests.post('https://api.cavyiot.com/device/delete', json=rbody)
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
#include <ArduinoJson.h>
const char* wifissid="Wifi-SSID";
const char* wifipassword="Wifi-Password";
StaticJsonDocument<800> json_body;
String userid= "Your-userid";  //Replace this userid with your own CavyIoT Userid.
String password="Your-password";  //Replace this password with your own CavyIoT Password.
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/device/delete"); 
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
    EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
                json_body["userid"]=userid;
                json_body["password"]=password;
                JsonArray devices = json_body.createNestedArray("devices");
                json_body["devices"][0]="device_name1";
                json_body["devices"][1]="device_name2";
   serializeJson(json_body, rbody);
   EspPostMethod(rbody);
      
}

void loop() {
  // put your main code here, to run repeatedly:

}

QUERY PARAMETERS

Field	Type	Description
userid	String	Your CavyIoT userid
password	String	Your CavyIoT password
device	String	Name of Device to delete from your account

Example Response- `application/json`


{
    "code": 200,
    "detail": "success",
    "deleted": [
        "device_name1",
        "device_name2"
    ]
}


{
    "code": 207,
    "detail": "Partial success",
    "deleted": [
        {
            "device": "device_name1",
            "api_key": "6kB2SrZOXeYzGMLUdcWg"
        }
    ],
    "notfound": [
        "device_name2"
    ]
}


{
    "code": 404,
    "detail": "Devices not found.",
    "notfound": [
        "device_name1",
        "device_name2"
    ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}


{
    "code": 415,
    "detail": "Syntax Error"
}

Add Sensor/s

This endpoint Creates a new sensor/s variable.

↳ via `GET` method-

To add a single sensor variable to your IoT Dashboard you need to make a GET call to the following URL with parameters name, value, and unit-

https://api.cavyiot.com/{api_key}/sensor/add?name={name}&value={value}&unit={unit}

Example Request-


var link = "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/add?name=name&value=value&unit=unit";
var request = new XMLHttpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/add?name=name&value=value&unit=unit"


import requests
x = requests.get('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/add?name=name&value=value&unit=unit')
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String api-key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.

String sensor_name="Temperature";
int sensor_value=37;
String sensor_unit="C";//Celsius

HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/"+api-key+"/sensor/add?name="+sensor_name+"&value="+sensor_value+"&unit="+sensor_unit); 
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To add Multiple sensor variables to your IoT Dashboard you need to make a POST call to the following URL with JSON parameters- name, value, and unit-

https://api.cavyiot.com/{api_key}/sensor/add

Example Request-


var link = "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/add";
var request = new XMLHttpRequest();
var rbody= [{
            "name":"Temperature",
            "value":37,
            "unit":"C"
            },
            {
            "name":"Humidity",
            "value":42
            }];
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://team.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/add" -H "Content-Type: application/json" -d "[{\"name\":\"temperature\"},{\"name\":\"humidity\",\"value\":40,\"unit\":\"RH\"}]"


import requests
rbody=[{'name':'sensor_name1','value':'sensor_value1','unit':'C'},{'name':'sensor_name2'},{'name':'sensor_name3','unit':'%'}]
x = requests.post('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/add', json=rbody)
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
#include <ArduinoJson.h>
const char* wifissid="Wifi-SSID";
const char* wifipassword="Wifi-Password";
StaticJsonDocument<800> json_body;
String api_key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/"+api_key+"/sensor/add"); 
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
    EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
                JsonObject sensor1 = json_body.createNestedObject();
                 sensor1["name"] = "Temperature";
                 sensor1["value"] = "00.00";
                 sensor1["unit"] = "C";
                JsonObject sensor2 = json_body.createNestedObject();
                 sensor2["name"] = "Humidity";
                 sensor2["value"] = "00.00";
                 sensor2["unit"] =  "RH";
   serializeJson(json_body, rbody);
   EspPostMethod(rbody);
      
}

void loop() {
  // put your main code here, to run repeatedly:

}

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
name	String	Your sensor Name
value (Optional)	Integer	Your sensor Value
unit (Optional)	String	Your sensor Unit

Example Response- `application/json`


{
    "code": 200,
    "detail": "success.",
    "added": [
        "Temperature",
        "Humidity"
    ]
}


{
    "code": 207,
    "detail": "Partialy success ",
    "added": [
        "Temperature"
    ],
    "discarded": [
        "Humidity"
    ]
}


{
    "code": 208,
    "detail": "Sensor already in List",
    "discarded": [
        "Temperature",
        "Humidity"
    ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}


{
    "code": 406,
    "detail": "Not Acceptable. Maximum sensor variables reached out."
}


{
    "code": 410,
    "detail": "Service expired. Resource not available."
}


{
    "code": 415,
    "detail": "Syntax Error"
}

Update Sensor/s

This endpoint Updates value of a existing sensor/s variable.

↳ via `GET` method-

To update a single sensor variable to your IoT Dashboard you need to make a GET call to the following URL with parameters name, value, and unit-

https://api.cavyiot.com/{api_key}/sensor/update?name={name}&value={value}&unit={unit}

Example Request-


var link = "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/update?name=name&value=value&unit=unit";
var request = new XMLHttpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/update?name=name&value=value&unit=unit"


import requests
x = requests.get('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/update?name=name&value=value&unit=unit')
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String api-key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.

String sensor_name="Temperature";
int sensor_value=37;
String sensor_unit="C";//Celsius

HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/"+api-key+"/sensor/update?name="+sensor_name+"&value="+sensor_value+"&unit="+sensor_unit); 
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To update Multiple sensor variables to your IoT Dashboard you need to make a POST call to the following URL with JSON parameters- name, value, and unit-

https://api.cavyiot.com/{api_key}/sensor/update

Example Request-


var link = "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/update";
var request = new XMLHttpRequest();
var rbody= [{
            "name":"Temperature",
            "value":37,
            "unit":"C"
            },
            {
            "name":"Humidity",
            "value":42
            }];
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://team.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/update" -H "Content-Type: application/json" -d "[{\"name\":\"temperature\",\"value\":32},{\"name\":\"humidity\",\"value\":40,\"unit\":\"RH\"}]"


import requests
rbody=[{'name':'Temperature','value':32,'unit':'C'}{'name':'Humidity','value':40}]
x = requests.post('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/update', json=rbody)
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
#include <ArduinoJson.h>
const char* wifissid="Wifi-SSID";
const char* wifipassword="Wifi-Password";
StaticJsonDocument<800> json_body;
String api_key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/"+api_key+"/sensor/update"); 
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
    EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
                JsonObject sensor1 = json_body.createNestedObject();
                 sensor1["name"] = "Temperature";
                 sensor1["value"] = 32.5;
                 sensor1["unit"] = "C";             //Optional
                JsonObject sensor2 = json_body.createNestedObject();
                 sensor2["name"] = "Humidity";
                 sensor2["value"] = 45;
                 sensor2["unit"] =  "RH";           //Optional
   serializeJson(json_body, rbody);
   EspPostMethod(rbody);
      
}

void loop() {
  // put your main code here, to run repeatedly:

}

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
name	String	Your sensor Name
value	Integer/Float	Your sensor Value
unit (Optional)	String	Your sensor Unit

Example Response- `application/json`


{
    "code": 200,
    "detail": "success.",
    "updated": [
        {
            "name": "Humidity",
            "value": 45,
            "unit": "C",
            "unix_time": 1607460649
        },
        {
            "name": "Temperature",
            "value": 32.5,
            "unit": "C",
            "unix_time": 1607460649
        }
    ]
}


{
    "code": 207,
    "detail": "partialy success.",
    "updated": [
        {
            "name": "Temperature",
            "value": 32.5,
            "unit": "C",
            "time": 1607460582
        }
    ],
    "notfound": [
        "speed"
    ]
}


{
    "code": 404,
    "detail": "sensor not found.",
    "notfound": [
        "pressure",
        "speed"
    ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}


{
    "code": 410,
    "detail": "Service expired. Resource not available."
}


{
    "code": 415,
    "detail": "Syntax Error"
}

Delete Sensor/s

This endpoint Deletes a existing sensor/s variable.

↳ via `GET` method-

To delete a single sensor variable from your IoT Dashboard you need to make a GET call to the following URL with parameters sensor name with api_key as path as parameter-

https://api.cavyiot.com/{api_key}/sensor/delete?name={name}

Example Request-


var link = "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/delete?name=sensor_name";
var request = new XMLHttpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/delete?name=sensor_name"


import requests
x = requests.get('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/delete?name=sensor_name')
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String api-key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.

String sensor_name="Temperature";

HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/"+api-key+"/sensor/delete?name="+sensor_name); 
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To delete Multiple sensor variables from your IoT Dashboard you need to make a POST call to the following URL with JSON parameters- name-

https://api.cavyiot.com/{api_key}/sensor/delete

Example Request-


var link = "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/delete";
var request = new XMLHttpRequest();
var sensor_name1 = "Temperature";
var sensor_name2 = "Humidity";
var rbody= [{
            "name":sensor_name1
            },
            {
            "name":sensor_name2
            }];
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://team.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/delete" -H "Content-Type: application/json" -d "[{\"name\":\"temperature\"},{\"name\":\"humidity\"}]"


import requests
rbody=[{'name':'sensor_name1'},{'name':'sensor_name2'},{'name':'sensor_name3'}]
x = requests.post('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/sensor/delete', json=rbody)
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
#include <ArduinoJson.h>
const char* wifissid="Wifi-SSID";
const char* wifipassword="Wifi-Password";
StaticJsonDocument<800> json_body;
String api_key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/"+api_key+"/sensor/delete"); 
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
    EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
                JsonObject sensor1 = json_body.createNestedObject();
                 sensor1["name"] = "Temperature";
                 
                JsonObject sensor2 = json_body.createNestedObject();
                 sensor2["name"] = "Humidity";
                 
   serializeJson(json_body, rbody);
   EspPostMethod(rbody);
      
}

void loop() {
  // put your main code here, to run repeatedly:

}

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
name	String	Your sensor Name

Example Response- `application/json`



{
    "code": 200,
    "detail": "success",
    "deleted": [
        "speed"
    ]
}


{
    "code": 207,
    "detail": "Partially success.",
    "deleted": [
        "Temperature"
    ],
    "notfound": [
        "speed"
    ]
}


{
    "code": 404,
    "detail": "sensor not found.",
    "deleted": [],
    "notfound": [
        "Humidity",
        "Temperature"
    ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
    
}


{
    "code": 410,
    "detail": "Service expired. Resource not available."
    
}


{
    "code": 415,
    "detail": "Syntax Error"
    
}

Chart Feed Data

This endpoint Feeds a data-points into a Chart.

↳ via `GET` method-

To update a single data-point to a chart you need to make a GET call to the following URL with parameters api_key, name, and value-

https://api.cavyiot.com/{api_key}/chart/feed?name={name}&value={value}

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
name	String	Sensor name
value	Integer/Float	Sensor Value

Example Request-


//Note:- Use this call only if you want a chart for a single sensor variable
// This endpoint creates a Chart Base only for one sensor variable.

var api_key = "3JzIfYb1GXN9cFlTB2do";
var link = "https://api.cavyiot.com/"+api_key+"/chart/feed?name=Temperature&value=34";
var request = new XMLHttpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/chart/feed?name=Temperature&value=32"


import requests
#edit/replace index and label with your own
x = requests.get('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/chart/feed?name=Temperature&value=32')
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String api-key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.

HTTPClient http;
void EspGetMethod()
 {
  http.begin("https://api.cavyiot.com/"+api_key+"/chart/feed?name=Temperature&value=32"); //Replace button_index and state with your own
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To update a chart with more than one sensor variable you need to make a POST call to the following URL with JSON body with parameters- Array of name, and value-

https://api.cavyiot.com/{api_key}/chart/feed

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
name	String	Sensor name
value	Integer/Float	Sensor Value

Example Request-


var api_key = "3JzIfYb1GXN9cFlTB2do";
var link = "https://api.cavyiot.com/api_key/chart/feed";
var request = new XMLHttpRequest();
var rbody= [{
            "name":"Temperature",
            "value":32
            },
            {
            "name":"Humidity",
            "value":40
            }];
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/chart/feed" -H "Content-Type: application/json" -d "[{\"name\":\"Temperature\",\"value\":32},{\"name\":\"Humidity\",\"value\":40}]"


import requests
rbody=[{
            "name":"Temperature",
            "value":32
            },
            {
            "name":"Humidity",
            "value":40
            }]
x = requests.post('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/chart/feed', json=rbody)
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
#include <ArduinoJson.h>
const char* wifissid="Wifi-SSID";
const char* wifipassword="Wifi-Password";
StaticJsonDocument<800> json_body;
String api_key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/"+api_key+"/chart/feed"); 
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
    EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
                JsonObject sensor1 = json_body.createNestedObject();
                 sensor1["name"] = "Temperature";
                 sensor1["value"] = "32.00";
                JsonObject sensor2 = json_body.createNestedObject();
                 sensor2["name"] = "Humidity";
                 sensor2["value"] = "40.00";
   serializeJson(json_body, rbody);
   EspPostMethod(rbody);
      
}

void loop() {
  // put your main code here, to run repeatedly:

}

Example Response- `application/json`


{
    "code": 200,
    "detail": "success",
    "base": [
            "Temperature",
            "Humidity"
            ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}


{
    "code": 410,
    "detail": "Service expired. Resource not available."
}


{
    "code": 415,
    "detail": "Syntax Error"
}

Get Button Status

This endpoint fetches a current position/status of button/s.

↳ via `GET` method-

To get a position of a single button you need to make a GET call to the following URL with parameters api_key, and index-

https://api.cavyiot.com/{api_key}/button/status/{index}

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
index	Integer	Must be between 0-3

Example Request-


var api_key = "3JzIfYb1GXN9cFlTB2do";
var link = "https://api.cavyiot.com/"+api_key+"/button/status/2";
var request = new XMLHttpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/{api_key}/button/status/2"


import requests
x = requests.get('https://api.cavyiot.com/{api_key}/button/status/2')
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String api-key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.

HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/"+api_key+"/button/status/2"); //Replace button_index with your own
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To get position of more than one buttons you need to make a POST call to the following URL with JSON body with parameters- Array of index-

https://api.cavyiot.com/{api_key}/button/status

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
index	Array	Array of button indexes (must be 0-3)

Example Request-


var api_key = "3JzIfYb1GXN9cFlTB2do";
var link = "https://api.cavyiot.com/api_key/button/status";
var request = new XMLHttpRequest();
var rbody= {
            "index":[0,1,2]
            };
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/button/status" -H "Content-Type: application/json" -d "{\"index\":[0,1,2]}"


import requests
rbody={"index":[0,1,2]}
x = requests.post('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/button/status', json=rbody)
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
#include <ArduinoJson.h>
const char* wifissid="Wifi-SSID";
const char* wifipassword="Wifi-Password";
StaticJsonDocument<800> json_body;
String api_key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/"+api_key+"/button/status"); 
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
    EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
                JsonArray devices = json_body.createNestedArray("index");
                json_body["index"][0]=0;
                json_body["index"][1]=1;
                json_body["index"][2]=2;
   serializeJson(json_body, rbody);
   EspPostMethod(rbody);
      
}

void loop() {
  // put your main code here, to run repeatedly:

}

Example Response- `application/json`


{
    "code": 200,
    "detail": "success",
    "buttons": [
        {
            "index": "0",
            "label": "Fan",
            "state": "ON",
            "lastupdate": {
                "time": "00:08:37",
                "date": "2020-12-10"
            }
        },
        {
            "index": "1",
            "label": "LED2",
            "state": "ON",
            "lastupdate": {
                "time": "22:44:31",
                "date": "2020-12-10"
            }
        },
        {
            "index": "2",
            "label": "LED3",
            "state": "OFF",
            "lastupdate": {
                "time": "02:34:47",
                "date": "2020-11-27"
            }
        }
    ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}


{
    "code": 410,
    "detail": "Service expired. Resource not available."
}


{
    "code": 415,
    "detail": "Syntax Error"
}

Update Button

This endpoint Updates a current position/status of button/s.

↳ via `GET` method-

To update a position of a single button you need to make a GET call to the following URL with parameters api_key, index, and state-

https://api.cavyiot.com/{api_key}/button/update?index={index}&state={state}&label={label}

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
index	Integer	Must be between 0-3
state	String	Must be ON or OFF
label (Optional)	String	Set button label (Should not contain SPACE character)

Example Request-


var api_key = "3JzIfYb1GXN9cFlTB2do";
var link = "https://api.cavyiot.com/"+api_key+"/button/update?index=2&state=ON&label=LED1";   //Note:- label is optional
var request = new XMLHttpRequest();

request.open('GET', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


curl -X GET "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/button/update?index=2&state=ON"


import requests
#edit/replace index and label with your own
x = requests.get('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/button/update?index=2&state=ON')
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>    
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
const char* wifissid = "WiFi-SSID";
const char* wifipassword = "WiFi-Password";

String api-key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.

HTTPClient http;
void EspGetMethod()
 {
  http.begin("http://api.cavyiot.com/"+api_key+"/button/update?index=2&state=ON"); //Replace button_index and state with your own
  int httpCode = http.GET();
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
     EspGetMethod();
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
            
   EspGetMethod(); 
    
}
void loop() {
  // put your main code here, to run repeatedly:

}

↳ via `POST` method-

To update position of more than one buttons you need to make a POST call to the following URL with JSON body with parameters- Array of index, and state-

https://api.cavyiot.com/{api_key}/button/update

QUERY PARAMETERS

Field	Type	Description
api_key	String	Your device API key
index	Integer	Button index
state	String	Button state (Must be ON or OFF)
label (Optional)	String	Button label (Should not contain SPACE character)

Example Request-


var api_key = "3JzIfYb1GXN9cFlTB2do";
var link = "https://api.cavyiot.com/api_key/button/update";
var request = new XMLHttpRequest();
var rbody= [{
            "index":1,
            "state":"ON"
            },
            {
            "index":2,
            "state":"OFF",
            "label":"BULB"
            }];
request.open('POST', link);

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send(JSON.stringify(rbody));


curl -X POST "https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/button/update" -H "Content-Type: application/json" -d "[{\"index\":\"1\",\"state\":\"ON\"},{\"index\":\"2\",\"state\":\"OFF\"}]"


import requests
rbody=[{"index":"1","state":"ON"},{"index":"2","state":"OFF"}]
x = requests.post('https://api.cavyiot.com/3JzIfYb1GXN9cFlTB2do/button/update', json=rbody)
print(x.json())


#ifdef ESP8266
#include <ESP8266WiFi.h>   
#include <ESP8266HTTPClient.h>
#else
#include <WiFi.h>     
#include <HTTPClient.h>
#endif
#include <ArduinoJson.h>
const char* wifissid="Wifi-SSID";
const char* wifipassword="Wifi-Password";
StaticJsonDocument<800> json_body;
String api_key= "3JzIfYb1GXN9cFlTB2do";  //Replace this API-key with your own.
String rbody;
HTTPClient http;
void EspPostMethod(String rbody)
 {
  http.begin("http://api.cavyiot.com/"+api_key+"/button/update"); 
  int httpCode = http.POST(rbody);
  if(httpCode<0){
    http.end();
     Serial.println("...Server busy.. Trying to attempt again please wait.. ");
    EspPostMethod(rbody);
    }
  else{
     Serial.println("");
     Serial.println(http.getString());
     http.end();
    }
  }
void setup() {
 Serial.begin(9600);        
 WiFi.begin(wifissid,wifipassword); 
 while (WiFi.status() != WL_CONNECTED ) 
          { 
          delay(500); 
           Serial.print(".");
          }
                JsonObject button1 = json_body.createNestedObject();
                 button1["index"] = 1;
                 button1["state"] = "ON";
                JsonObject button2 = json_body.createNestedObject();
                 button2["index"] = 2;
                 button2["state"] = "OFF";
   serializeJson(json_body, rbody);
   EspPostMethod(rbody);
      
}

void loop() {
  // put your main code here, to run repeatedly:

}

Example Response- `application/json`


{
    "code": 200,
    "detail": "success",
    "updated": [
        {
            "index": "1",
            "state": "OFF",
            "unix_time": 1607784578
        },
        {
            "index": "2",
            "state": "ON",
            "unix_time": 1607784578
        }
    ]
}


{
    "code": 207,
    "detail": "Partial success",
    "updated": [
        {
            "index": "2",
            "state": "OFF",
            "unix_time": 1607784779
        }
    ],
    "discarded": [
        {
            "index": "1",
            "state": "OFF"
        }
    ]
}


{
    "code": 208,
    "detail": "Already reported",
    "discarded": [
        {
            "index": "1",
            "state": "ON"
        },
        {
            "index": "2",
            "state": "OFF"
        }
    ]
}


{
    "code": 401,
    "detail": "Incorrect authentication credentials."
}


{
    "code": 410,
    "detail": "Service expired. Resource not available."
}


{
    "code": 415,
    "detail": "Syntax Error"
}

Response Schema-

Field	Type	Description
code	Integer	Response status code
detail	String	Response status description
device_list	Array	Array of devices in your account. Contains information of device such as- (JSON object) device name (String) api_key (String) active_since (String) service_expires (String)
device_status	JSON object	JSON object of specific device. Contains information of device such as- timezone (String) name (String) active_since (String) service_expires (String) auto_mode (boolean) sensors (Array JSON object of sensors connected to device) contains information- name (String) value (Integer) unit (String) time (String) date (String)
added	Array	When the record is added in database. Response parameters depends on API call- Add Device (JSON object) device name (String) api_key (String) Add Sensor- (List of Added sensors into IoT Dashboard)
discarded	Array	When the record is added in database. Response parameters depends on API call- Add Device `207` (JSON object) device name (String) api_key (String) Add Device `208` (List of Device name/s) Add Sensor- (List of Added sensors into IoT Dashboard) Update Button (JSON object) index (String) state (String)
deleted	Array	When the record or variable is deleted from database.- Delete Device (List of Deleted device/s) Add Device (List of Deleted sensor/s)
updated	Array	When the record is added in database. Response parameters depends on API call- Update Sensor/s (JSON object) name (String) value (Integer) unit (String) unix_time (Integer) Update Button/s (JSON object) index (String) state (String) unix_time (Integer)
notfound	Array	When you try to UPDATE or DELETE an entity which does not exist, then server returns this (notfound) response as array of entity or entities(sensor name/device name).
base	Array	List of sensor names present in your chart data.
buttons	Array	JSON object of buttons with information of index (String) label (String) state (String) lastupdate (JSON object)- time (String) date (String)
sensors	Array	JSON object of sensors with information of name (String) value (Integer) unit (String) lastupdate (JSON object)- time (String) date (String)

Response Codes-

The CavyIoT RESTful API uses the following response codes:

Code	Meaning	Description
200	Success.	This response code indicates that the request has succeeded.
207	Partially success.	This response code indicates that when you try to UPDATE, DELETE, or ADD multiple entities, and the server could not find or discarded any of them entity.
208	Already reported.	This response code indicates that you are trying to overwrite an entity.
401	Incorrect authentication credentials.	This response code indicates that the request has not been applied because it lacks valid authentication credentials such as `api_key` or `userid & password` for the target resource.
404	Not found.	This response code indicates that the resource you are trying to UPDATE or DELETE is not available on server.
406	Not Acceptable.	This response code indicates that the server could not accept your request.
410	Service expired. Resource not available.	This response code indicates that service for your device has been expired.
415	Syntax error.	This response code indicates that the request body is not valid i.e. syntax error.

CavyIoT HTTP RESTful API

Get started

API URL

Get API-KEY

↳ via GET method-

Example Request-

↳ via POST method-

Example Request-

QUERY PARAMETERS

Example Response- application/json🔗

Get current status of device

QUERY PARAMETERS

Example Request-

Example Response- application/json

Add Device

↳ via GET method-

Example Request-

↳ via POST method-

Example Request-

QUERY PARAMETERS

Example Response- application/json

Delete Device

↳ via GET method-

Example Request-

↳ via POST method-

Example Request-

QUERY PARAMETERS

Example Response- application/json

Add Sensor/s

↳ via GET method-

Example Request-

↳ via POST method-

Example Request-

QUERY PARAMETERS

Example Response- application/json

Update Sensor/s

↳ via GET method-

Example Request-

↳ via POST method-

Example Request-

QUERY PARAMETERS

Example Response- application/json

Delete Sensor/s

↳ via GET method-

Example Request-

↳ via POST method-

Example Request-

QUERY PARAMETERS

Example Response- application/json

Chart Feed Data

↳ via GET method-

QUERY PARAMETERS

Example Request-

↳ via POST method-

QUERY PARAMETERS

Example Request-

Example Response- application/json

Get Button Status

↳ via GET method-

QUERY PARAMETERS

Example Request-

↳ via POST method-

QUERY PARAMETERS

Example Request-

Example Response- application/json

Update Button

↳ via GET method-

QUERY PARAMETERS

Example Request-

↳ via POST method-

QUERY PARAMETERS

Example Request-

Example Response- application/json

Response Schema-

Response Codes-

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`🔗

Example Response- `application/json`

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`

↳ via `GET` method-

↳ via `POST` method-

Example Response- `application/json`