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

Store Device Push Token

Request

Store instance token to facilitate the usage of firebase services between App Cloud and Wifi Motion App.

The instance token provides a unique identifier for each app instance and a mechanism to authenticate and authorize actions (example: sending FCM messages)

If the token sent is set to 'eee-motioncsc-loadtest' the push notification payload will be formed but NOT sent to firebase. This is used in load testing to ensure APPCLD is not blacklisted by Google.

Security
Authorization
Bodyapplication/json
tokenstringrequired
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/mobile_devices \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string"
  }'

Responses

Bodyapplication/json
idinteger
Example: 2345
tokenstring
Example: "egxcipdIRm2Ng4pWuJuRN3:APA91bE2M42o7XBlVMAslS9YhWVr3ELXmDCM8QebHAMwvVuRWA8nYahtPvUA3LV0A-t2PW4jhmn0RF7omCpQ9BH-n6WA5CVyN1hNfsgf7EqP01Z2Hpto7NeA-ewBQAtJIgmfrBl6-rEG"
user_idinteger
Example: 345
created_atstring
Example: "2020-09-08 15:30:32"
updated_atstring
Example: "2020-09-08 15:30:32"
Response
application/json
{
  "id": 2345,
  "token": "egxcipdIRm2Ng4pWuJuRN3:APA91bE2M42o7XBlVMAslS9YhWVr3ELXmDCM8QebHAMwvVuRWA8nYahtPvUA3LV0A-t2PW4jhmn0RF7omCpQ9BH-n6WA5CVyN1hNfsgf7EqP01Z2Hpto7NeA-ewBQAtJIgmfrBl6-rEG",
  "user_id": 345,
  "created_at": "2020-09-08 15:30:32",
  "updated_at": "2020-09-08 15:30:32"
}

Delete Members

Request

Security
Authorization
Path
idinteger>= 1required
curl -i -X DELETE \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/network_memberships/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Show Network Members

Request

Security
Authorization
Query
expandArray of strings
network_idinteger
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/network_memberships?expand=string&network_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects
Response
application/json
{
  "data": [
    { … }
  ]
}

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

Operations