# APIs
The purpose of Cloud Express is to add value for its users and partners by collecting device telemetry and asset data and storing it in the cloud. This is usually achieved by developing custom applications that target individual markets, segments, or even customers.
Webinars
We recommend you to watch the following recording to gain a better understanding of the topic:
The listing of all webinars can be found here
# Overview
Cloud Express provides its users with a comprehensive set of APIs to facilitate the development of impactful solutions. The available set of endpoints allows users a breadth of functionality to interact with live streaming data, stored data, object models, as well as manage their security and permission settings.
From the developer's perspective, Cloud Express consists of a range of APIs that are meant to aid users with developing their solutions. One could argue that it's more than that - after all, Cloud Express also offers an Admin Portal, which is a web application with a GUI. However, it's important to note that this application uses Cloud Express APIs in the background, and all of the functionalities that it offers could be achieved with HTTP calls to the right endpoints!
This part of the Cloud Express Developer Portal covers the following APIs:
- IAM
- Audit Logging
- IM
- TDR
- DCS
- Command Queue Processor
- File Upload Processor
# Environment Setup
Before the Cloud Express instance can be utilized, an Ability Solution must be requested. A Solution can be seen as a container for various entities that you will want to create - application identities, grants, devices, etc. With the Solution defined, the Cloud Express is ready for development tasks. The steps to request, configure and verify a Solution are covered in the following articles in this section of ADP.
TIP
In the following articles of this section, we go through a simple example of environment setup, just as a reference. It is recommended that you contact your Client Success Team representative to establish what configuration will be optimal for your case. The only article that is valid in every case in this section, is the VNet Peering. Otherwise, feel free to learn about the available APIs, by navigating to the appropriate sections using the sidebar on the left.
The Ability Multitenant functionality defines different types of users. It is important to understand these terms before looking at an example configuration.
- Ability Administrator
- Solution Administrator
- Tenant Administrator
- Tenant User
All of these roles are described here.
Once an Cloud Express Instance is requested and the environment is delivered, this information can be used to request your solution. The following sections go through the basic steps to complete the solution creation process.
# Request Solution
Using your instance information, a ServiceNow ticket must be opened with Ability Operations to create your solution. Solutions support connections to multiple Tenants. The Ability Platform supports Azure Active Directory B2C. In production, the tentants are typically the Azure Active Directories of the BL's customers. For development, a test Microsoft Tenant can be created. This basic setup requires at least two users:
- Tenant Administrator
- Tenant User
Once this is information is available, the ServiceNow ticket can be created to request your solution. This solution example provided will suppport:
- Two Roles. One all access role for the Tenant Administrator and a read-only role for the Tenant User.
- Two Tenants. BLs will monitor devices from multiple customers.
- Background application. This application will allow the BL to access the data from all tenants
- Single Page App application. All tenant users will use this to access the data in stored in their respective tenants.
These Multitenant configuration choices represent a small subset of supported functionality and many other configurations are possible.
# Configure Solution
Once operations has completed your solutions requset, the configuration can be completed. This includes:
- Defining the Roles and Grants
- Setting up applications to view all the solution data.
The solution configuration provides detailed steps to complete this task.
# Configure Tenant
Once the Roles and Grants are defined, you can notify the Tenant Administrators they can login to assign grants to their users.
- An Admin Role that provides permission to everything.
- A User Role that can access all the data collected.
The tenant configuration provides detailed steps to complete this task.
# Test Configuration
Once everything is configured, access can be verified. A small application has been provided that can be modified to verify access to the Cloud Express. Follow the instructions provided here to verify access.