Skip to content

Cognitive Systems App Cloud API

The App Cloud APIs expose the Core API endpoints, but with the addition of adding per user authentication and authorization. For example, you may choose to build with App Cloud APIs when developing for a mobile platform.

Download OpenAPI description
app_cloud.json
app_cloud.yaml
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/
https://docs.cognitivesystems.com/api/v1/

Overview

Operations

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Update scene event for user's network

Request

Change the scene of user's network.

Accepts scene_id:

  • 1 : SceneChangedToAwayEvent
  • 4 : SceneChangedToHomeEvent
Security
Authorization
Bodyapplication/jsonrequired
scene_idinteger
Example: 1
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/scenes \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "scene_id": 1
  }'

Responses

OK

Show General Settings

Request

Android and iOS versions app have variations in how the request + response for GET /networks is made. There is a top level data key that is sometimes expected and other times is not, and there is differences in the id parameter.

Security
Authorization
Query
pageinteger
Default 1
expandArray of strings
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks?page=1&expand=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects
Example: [{"id":19,"name":"Test Network 1","created_at":"2020-11-17T18:40:34.936Z","updated_at":"2020-11-17T18:42:16.096Z","external_id":21,"user_count":1,"latitude":"0.0000000","longitude":"0.0000000","address":"","timezone":"Etc/GMT","pet_size":"none","building_type":"bungalow","building_size":"small","live_enabled":true,"scene_id":4,"owner_email":"cb549858-e70e-4359-81bf-3003f32ca071@wifimotion.ca","present_count":1,"claimed":true,"network_scene_config":19}]
Response
application/json
{
  "data": [
    { … }
  ]
}

Update Leaf Settings

Request

Security
Authorization
Bodyapplication/json
friendly_namestring

The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as "Bedroom" rather than the mac address of the device that is located in the bedroom.

locationstring

Set as empty string to specify mobile device. Can also use 'mobile' boolean field to do this.

mac_addressstring^((([0-9A-F]{2}:){5})|(([0-9A-F]{2}-){5})|([0...required
network_idintegerrequired
autostring
Enum"1""""0"
mobileboolean
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/leaf \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "friendly_name": "string",
    "location": "string",
    "mac_address": "string",
    "network_id": 0,
    "auto": "1",
    "mobile": true
  }'

Responses

OK

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations