Cognitive Systems WiFi Motion App-Cloud API (v1-5-x)

App Cloud APIs are used by mobile applications.

Download OpenAPI description
v1-5-x.json
v1-5-x.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/

https://docs.cognitivesystems.com/api/v1/

Overview

Operations

Out of Box

Operations

Create User

Request

Creates an unconfirmed user that is not associated with any motion network

Bodyapplication/json
emailstringrequired
passwordstringrequired
first_namestringrequired
last_namestringrequired
usernamestring
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/users \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "password": "string",
    "first_name": "string",
    "last_name": "string",
    "username": "string"
  }'

Responses

Bodyapplication/json
usernamestring
emailstring
first_namestring
last_namestring
created_atstring
updated_atstring
confirmed_atstring or null
idinteger
Response
application/json
{
  "username": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "created_at": "string",
  "updated_at": "string",
  "confirmed_at": "string",
  "id": 0
}

Network Search/Create

Request

Get or create a Wi-Fi Motion network in App Cloud. The BSSID is shared with Core when the network first comes online.

This endpoint verifies the existence of the user's network in Core and if it's claimable. If the network is present in Core, but not in App Cloud, the network is created.

Calling this endpoint has one of the following outcomes:

  • Network not found in MNS Core (404)
  • Network found, already in App Cloud and returned (200)
  • Network found, not in App Cloud, created, and returned (200)

In the response object, claimed tells you whether the network has an owner.

If claimed is false, the network can be claimed by calling /api/v1/network_memberships. If claimed is true, the user can only be added as a member.

Bodyapplication/jsonrequired
bssidstringrequired
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/searches \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "bssid": "string"
  }'

Responses

Bodyapplication/json
idinteger
addressstring
building_sizestring
building_typestring
latitudestring or integer
Any of:
string
longitudestring or integer
Any of:
string
live_enabledboolean
name(string or null)
Any of:
string or null
pet_sizestring
external_idinteger
timezonestring
user_countinteger
scene_idinteger
created_atstring
updated_atstring
network_scene_configobject or number
Any of:
object
claimedboolean
is_ownerboolean
subscription_idstring or null
Response
application/json
{
  "id": 0,
  "address": "string",
  "building_size": "string",
  "building_type": "string",
  "latitude": "string",
  "longitude": "string",
  "live_enabled": true,
  "name": "string",
  "pet_size": "string",
  "external_id": 0,
  "timezone": "string",
  "user_count": 0,
  "scene_id": 0,
  "created_at": "string",
  "updated_at": "string",
  "network_scene_config": {},
  "claimed": true,
  "is_owner": true,
  "subscription_id": "string"
}

Network Find/Create

Request

Get or create a Wi-Fi Motion network in App Cloud. The Guardian Id is shared with Core when the network first comes online.

This endpoint verifies the existence of the user's network in Core and if it's claimable. If the network is present in Core, but not in App Cloud, the network is created.

Calling this endpoint has one of the following outcomes:

  • Network not found in MNS Core (404)
  • Network found, already in App Cloud and returned (200)
  • Network found, not in App Cloud, created, and returned (200)

In the response object, claimed tells you whether the network has an owner.

If claimed is false, the network can be claimed by calling /api/v1/network_memberships. If claimed is true, the user can only be added as a member.

Bodyapplication/jsonrequired
guardian_idstringrequired
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/find \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "guardian_id": "string"
  }'

Responses

Bodyapplication/json
idinteger
addressstring
building_sizestring
building_typestring
latitudestring or integer
Any of:
string
longitudestring or integer
Any of:
string
live_enabledboolean
name(string or null)
Any of:
string or null
pet_sizestring
external_idinteger
timezonestring
user_countinteger
scene_idinteger
created_atstring
updated_atstring
network_scene_configobject or number
Any of:
object
claimedboolean
is_ownerboolean
subscription_idstring or null
Response
application/json
{
  "id": 0,
  "address": "string",
  "building_size": "string",
  "building_type": "string",
  "latitude": "string",
  "longitude": "string",
  "live_enabled": true,
  "name": "string",
  "pet_size": "string",
  "external_id": 0,
  "timezone": "string",
  "user_count": 0,
  "scene_id": 0,
  "created_at": "string",
  "updated_at": "string",
  "network_scene_config": {},
  "claimed": true,
  "is_owner": true,
  "subscription_id": "string"
}

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations