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

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/api/app_cloud/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/api/app_cloud/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"
}

Send Account Confirmation Email

Request

Endpoint to send confirmation email during account creation.

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

Responses

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