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

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Sensor Integration is the process where a standalone sensor (like a Motion Tag or Bath Sensor) establishes a secure communication link with the WiFi Motion Plug network.

Operations

Obtain Recommended Software Version

Request

Provides you with the recommended software version for your hub.

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/ota/hub/recommended

Responses

200 OK

Bodyapplication/json
versionstring

The recommended software version for the hub.

Response
application/json
{
  "version": "03.00.88.00"
}

Perform Sensor OTA Upgrade

Request

Allows you to update your sensor hub via an Over the Air (OTA) push.

Below is a list of the different status codes that you can receive while performing an Over the air (OTA) Hub upgrade:

Status Code Description
201The firmware will be triggered to deploy when the hub is online.
400There is an issue with the API request or the hub does not exist.
403The destination hub does not belong to the integration.
404The thingName was not found in Third Reality's Cloud.
505An invalid thingName or is an unsupported version. The firmware update failed to trigger.
Path
thingNamestringrequired

The ID of the sensor.

Bodyapplication/json
otaVersionstring

The software version to use to upgrade the hub.

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/ota/{thingName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "otaVersion": "03.00.88.00"
  }'

Responses

201 Created

Bodyapplication/json
thingNamestring

The hub thingName that is the target of the Over the Air (OTA) upgrade.

fromVersionstring

The software version that the hub is being upgraded from.

toVersionstring

The software version that the hub is being upgraded to.

Response
application/json
{
  "thingName": "HUB_A1B2CDEF345A",
  "fromVersion": "03.00.62.00",
  "toVersion": "03.00.88.00"
}

Third Party Event Ingress

Request

This endpoint is the web hook for the third party capture and relay of any and all events relating to hubs and sensors.

Bodyapplication/json
actionstringrequired
payloadobjectrequired

Contains the information that is being updated. The payload object can be empty.

payload.​userThingNamestring

When used, the field is always prefixed with USER_.

payload.​unitstring

Identifies the type of value that is being reported. Can be either % or C.

payload.​humidityinteger[ 0 .. 100 ]

Provides the humidity level that is being reported by the sensor.

payload.​batteryLevelinteger[ 0 .. 100 ]

Contains the battery level that is being reported by the sensor.

reqIdstring

Contains a generated hash for request tracking.

thingNamestringrequired

Sensor or Hub thingName

curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/ingress \
  -H 'Content-Type: application/json' \
  -d '{
    "action": "DeviceAdded",
    "payload": {
      "userThingName": "USER_a0b1c2de3fa4567bc8901234567d8901"
    },
    "reqId": "0123abc456de7f890abc1de2f345a67b",
    "thingName": "SENSOR_ABCDE01F23456A7B"
  }'

Responses

No Content

The event was received and relayed.