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

Operations

Initialize Sensor Integration

Request

Initialize an integration. If integrations_enable is true, an account is created in the 3rd Reality Cloud and App Cloud is returned a userThingName which is necessary for HUB bluetooth initialization. This API can be called with intergrations_enabled: false, and then no userThingName will be returned. Setting integrations_enabled to false will not remove or make any changes to an existing integration.

Query
show_accountboolean

Debug only - shows the 3reality account creation fields in the response.

Default false
Bodyapplication/json
integrations_enableboolean
oob_phasestring
curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/integrations?show_account=false' \
  -H 'Content-Type: application/json' \
  -d '{
    "integrations_enable": true,
    "oob_phase": "string"
  }'

Responses

201 Created

Bodyapplication/json
Response
application/json
{
  "integrations": {
    "id": 18,
    "integrations_enable": true,
    "network_id": 1,
    "external_id": 4,
    "user_id": 101,
    "userThingName": "USER_c9d3c1ee5cd2458da1843095422f4141",
    "oob_phase": "",
    "created_at": "2025-06-06T16:01:07.715Z",
    "updated_at": "2025-06-06T16:01:07.715Z",
    "external_account": "CSC_0001M4682FCQM9HCD3GZRSMGSV@wifimotion.ca",
    "external_email": "0001M4682FCQM9HCD3GZRSMGSV@wifimotion.ca",
    "external_password": "CSC.01JX33CD6KBWVMNM91W6QMW2Z4",
    "external_token": "eyJhY2....4c6d0773"
  }
}

Obtain Sensor Integration

Request

Get Integration configuration.

Query
show_accountboolean

Debug only - shows the 3rd Reality account fields in the response.

Default false
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/integrations?show_account=false'

Responses

200 OK

Bodyapplication/json
Response
application/json
{
  "integrations": {
    "id": 18,
    "integrations_enable": true,
    "network_id": 1,
    "external_id": 4,
    "user_id": 101,
    "userThingName": "USER_c9d3c1ee5cd2458da1843095422f4141",
    "oob_phase": "",
    "created_at": "2025-06-06T16:01:07.715Z",
    "updated_at": "2025-06-06T16:01:07.715Z"
  }
}

Update Sensor Integration

Request

Mutate fields of an initialized integration.

Bodyapplication/json
integrations_enableboolean
oob_phasestring
curl -i -X PATCH \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/integrations \
  -H 'Content-Type: application/json' \
  -d '{
    "integrations_enable": true,
    "oob_phase": "started"
  }'