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

Get Meta of Network

Request

Shows the network's meta storage

Security
Authorization
Query
allboolean

all=true is available to show the meta storage as is (by passing the per user flattening of the user key in the storage object per that user) for both members or owners, this is meant only for internal use/debug

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/meta?all=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
networkobject
Example: {"config":true}
userobject
Example: {"some storage":"for only the user"}
Response
application/json
{
  "network": {
    "config": true
  },
  "user": {
    "some storage": "for only the user"
  }
}

Patch Meta Storage

Request

The API supports two storage areas:

  • network: a storage area that is shared by all network users, writable by the owner but only readable by a member
  • user: a read/write storage area that is only visible to the current user (member or owner)
Security
Authorization
Bodyapplication/jsonrequired
networkobject
Example: {"config":true}
userobject
Example: {"some storage":"for only the user"}
curl -i -X PATCH \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/meta \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": {
      "config": true
    },
    "user": {
      "some storage": "for only the user"
    }
  }'

Responses

OK

Delete Meta Storage

Request

Deletes network meta storage. Only the owner can perform this action.

Security
Authorization
curl -i -X DELETE \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/meta \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Sensor Integration

Operations