Skip to content

Cognitive Systems App Cloud API

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

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

Show Users

Request

Get basic user information

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

Responses

Bodyapplication/json
idinteger
Example: 98
usernamestring
emailstring
Example: "test@cognitivesystems.com"
first_namestring
Example: "Cognitive"
last_namestring
Example: "Systems"
created_atstring
Example: "2021-04-12T21:04:19.647Z"
updated_atstring
Example: "2021-04-12T21:04:38.403Z"
confirmed_atstring or null
Example: "2021-04-12T21:04:38.403Z"
Response
application/json
{
  "id": 98,
  "username": "",
  "email": "test@cognitivesystems.com",
  "first_name": "Cognitive",
  "last_name": "Systems",
  "created_at": "2021-04-12T21:04:19.647Z",
  "updated_at": "2021-04-12T21:04:38.403Z",
  "confirmed_at": "2021-04-12T21:04:38.403Z"
}

Reset Account Password

Request

Update user password. Endpoint used by the 'Enter new password page' in the reset password flow.

Bodyapplication/json
tokenstringrequired
passwordstring
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/password_resets \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string",
    "password": "string"
  }'

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"
}

Logout

Request

End the session for the current user. Requires valid JWT.

Security
Authorization
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/logout \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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