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.
Cognitive Systems App Cloud API
Download OpenAPI description
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/
https://docs.cognitivesystems.com/api/v1/
Bodyapplication/json
The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as "Bedroom" rather than the mac address of the device that is located in the bedroom.
Set as empty string to specify mobile device. Can also use 'mobile' boolean field to do this.
- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/leaf
- https://docs.cognitivesystems.com/api/v1/leaf
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/leaf \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"friendly_name": "string",
"location": "string",
"mac_address": "string",
"network_id": 0,
"auto": "1",
"mobile": true
}'- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/info
- https://docs.cognitivesystems.com/api/v1/networks/info
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/info \
-H 'Authorization: YOUR_API_KEY_HERE'OK
The Guardian ID is a unique identifier for a WiFi Motion network.
Example: "add5cfe79g12797e253e3623"
The unique identifier that the Motion Network System (MNS) uses to identify a network.
Example: 1
A unique identifier that the App-Cloud uses to identify a network.
Example: 2
A node is a network device that contains Cognitive System's proprietary WiFi Motion software. Examples can include Access Points (APs) and IoT devices.
Example: {"esp_1A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_2A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_3A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_4A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"}}
Response
application/json
{ "guardian_id": "add5cfe79g12797e253e3623", "external_id": 1, "network_id": 2, "nodes": { "esp_1A2B345C6D7E": { … }, "esp_2A2B345C6D7E": { … }, "esp_3A2B345C6D7E": { … }, "esp_4A2B345C6D7E": { … } } }
- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/network_scene_configs/{id}
- https://docs.cognitivesystems.com/api/v1/network_scene_configs/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/network_scene_configs/{id}' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
{ "id": 0, "excessive_motion_enabled": true, "excessive_motion_seconds": 0, "network_id": 0, "created_at": "string", "updated_at": "string", "auto_switching_enabled": true, "guardian_enabled": true, "guardian_weekday_start_time_hours": 0, "guardian_weekday_start_time_minutes": 0, "guardian_weekday_end_time_hours": 0, "guardian_weekday_end_time_minutes": 0, "guardian_weekend_start_time_hours": 0, "guardian_weekend_start_time_minutes": 0, "guardian_weekend_end_time_hours": 0, "guardian_weekend_end_time_minutes": 0 }