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

Login using Apple account and Begin Session

Request

This API endpoint allows users to create a session by authenticating via Apple’s Single Sign-On (SSO).

The endpoint validates an Apple JWT token and then follows the /sessions flow to establish a user session

Bodyapplication/json
userobject
access_tokenstringrequired

JWT token issued by Apple SSO

Example: "NEW.APPLE.AUTH.TOKEN"
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sessions/sso/apple \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "name": {
        "firstName": "John",
        "lastName": "Smith"
      },
      "email": "user@cognitivesystems.com"
    },
    "access_token": "NEW.APPLE.AUTH.TOKEN"
  }'

Responses

Bodyapplication/json
refresh_tokenstring
tokenstring
userobject
Response
application/json
{
  "refresh_token": "string",
  "token": "string",
  "user": {
    "id": 0,
    "username": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "created_at": "string",
    "updated_at": "string",
    "confirmed_at": "string",
    "sub": "string",
    "valid_from": 0
  }
}

Login using Google account and Begin Session

Request

This API endpoint allows users to create a session by authenticating via Google’s Single Sign-On (SSO).

The endpoint validates an Google JWT token and then follows the /sessions flow to establish a user session

Bodyapplication/json
access_tokenstringrequired

JWT token issued by Google SSO

Example: "NEW.GOOGLE.AUTH.TOKEN"
client_idstringrequired

JWT token issued by Google

Example: "NEW.GOOGLE.CLIENT.ID"
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sessions/sso/google \
  -H 'Content-Type: application/json' \
  -d '{
    "access_token": "NEW.GOOGLE.AUTH.TOKEN",
    "client_id": "NEW.GOOGLE.CLIENT.ID"
  }'

Responses

Bodyapplication/json
refresh_tokenstring
tokenstring
userobject
Response
application/json
{
  "refresh_token": "string",
  "token": "string",
  "user": {
    "id": 0,
    "username": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "created_at": "string",
    "updated_at": "string",
    "confirmed_at": "string",
    "sub": "string",
    "valid_from": 0
  }
}

Login using AWS Cognito and Begin Session

Request

This API endpoint allows users to create a session by authenticating via AWS Cognito's Single Sign-On (SSO).

The endpoint validates an Cognito JWT token and then follows the /sessions flow to establish a user session

Bodyapplication/json
access_tokenstringrequired

JWT token issued by AWS Cognito

Example: "NEW.COGNITO.AUTH.TOKEN"
curl -i -X POST \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sessions/sso/cognito \
  -H 'Content-Type: application/json' \
  -d '{
    "access_token": "NEW.COGNITO.AUTH.TOKEN"
  }'

Responses

200 OK

Bodyapplication/json
refresh_tokenstring
tokenstring
userobject
Response
application/json
{
  "refresh_token": "JWT TOKEN",
  "token": "JWT TOKEN",
  "user": {
    "id": 601,
    "email": "user@cognitivesystems.com",
    "first_name": "John",
    "last_name": "Smith",
    "created_at": "2020-01-04T22:05:38.793Z",
    "updated_at": "2020-01-04T22:06:02.059Z",
    "confirmed_at": "2020-01-04T22:06:02.056Z"
  }
}

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