Getting Started

The following sections introduce you to the standard EDM REST API and provide information on how to access the API product to get you started.

It includes all the standard API to add bulk devices, manage and troubleshoot them, create groups and templates, organizations and SIM management. With this you can create your own custom user interface by seamlessly integrating all these API. All these API will follow the Role Based Access Control (RBAC) which we follow in our IoT Operations Dashboard. The user can access only those APIs he/she is allowed to access.

For example, if a user doesn't have the delete device permission and tries to delete the device with API, he will get an Unauthorized error in response.

We have provided the details of the API request and response in the graphical desktop utility.

To invoke the API, you must know the server Name/URL/Cluster name. For the US, the cluster is https://us.ciscoiot.com and for the EU, the cluster is https://eu.ciscoiot.com.

Base URI

The prefix for EDM API is — …/nbapi/edm/{version}.

In United States, every API request will begin with the following base URI:

For v1 API

https://us.ciscoiot.com/nbapi/edm/v1

For v2 API

https://us.ciscoiot.com/nbapi/edm/v2

In European Union, every API request will begin with the following base URI:

For v1 API

https://eu.ciscoiot.com/nbapi/edm/v1

For v2 API

https://us.ciscoiot.com/nbapi/edm/v2

Authorization

  1. To authenticate, you need the access token and for access token you need the API Key. To get the API key, refer to API Key Creation.

  2. To generate an access token, refer to Steps to Generate Access Token.

  3. To authorize a user, you need the x-tenant id. The x-tenant-id is the ID of the organization in whose context all the API will be invoked. For example, the GET /devices will only fetch the devices present in the organization whose ID was passed in the header. To fetch the x-tenant-id, refer to Steps to fetch x-tenant-id.