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

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.

Bodyapplication/json
tokenstringrequired
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/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"
}

Resend Confirmation Email

Request

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

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.

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