Getting Started

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

It includes all the standard APIs to add network devices, assets, access methods and access control groups. All these APIs will follow the Role- Based Access Control (RBAC) which we follow in our IoT Operations Dashboard. You can access only those APIs that you are allowed to access.

High level overview of the API resources:

1. Access Control Groups: Groups of users used to manage access to Access Methods that are present in the group.
2. Access Methods: Protocols used to connect with the Network Devices and Assets Remotely.
3. Assets: Assets that are attached to the network devices that users can access.
4. Network Devices: SEA supports equipment like routers and switches with the option to install SEA Agent, add assets to the equipment.

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 SEA API is — …/nbapi/sramgmt/ext.

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

https://us.ciscoiot.com/nbapi/sramgmt/ext

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

https://eu.ciscoiot.com/nbapi/sramgmt/ext

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.