Skip to content

Cognitive Systems WiFi Motion AppCloud API (v1-5-x)

The AppCloud APIs are used by mobile applications to communicate with the Cognitive Systems Infrastructure.

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 Network Members

Request

Security
Authorization
Bodyapplication/json
rolestringrequired

"owner"

network_idintegerrequired
user_idintegerrequired
expandArray of strings
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/network_memberships \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "role": "string",
    "network_id": 0,
    "user_id": 0,
    "expand": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idintegerrequired

Incremental App Cloud Id used internally for memberships

rolestringrequired

Users with 'owner' role have full access to a network, while 'member' users do not

Enum"owner""member"
userinteger or object
Any of:
integer
networkinteger or object
Any of:
integer
created_atstring(date-time)required
updated_atstring(date-time)required
is_presentboolean
Response
application/json
{
  "id": 0,
  "role": "owner",
  "user": 0,
  "network": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "is_present": true
}

Resend Confirmation Email

Request

Endpoint to send another confirmation email when user presses 'RESEND EMAIL' button during account creation.

Security
Authorization
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/confirmation_mails \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Response
No content

Confirm New Account

Request

After the user receives a confirmation email. This link should open the app, and pass the included token to this User Confirmation GET request.

A successful response means that the account associated with the token/email is now confirmed, and can be used for OOB or view network as a member.

Note: This is NOT the same token as was returned by the #endpoint:u8SLn5ebDpLA96m7B endpoint. They are both jwt tokens with the same format but they have different token audience, expiry and payload data.

Security
Authorization
Query
tokenstring[Bearer\s]?[a-zA-Z0-9\-_]+?\.[a-zA-Z0-9\-_]+?...required
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/confirmations?token=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger
emailstring
first_namestring
last_namestring
usernamestring
confirmed_atstring or null
created_atstring
updated_atstring
Response
application/json
{
  "id": 0,
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "username": "string",
  "confirmed_at": "string",
  "created_at": "string",
  "updated_at": "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