API Overview and Getting Started

Full Suite of APIs for Device and Sensor Data Access and Control

Start Developing Your Solution or Application Today. Create an Account

APIs to Meet Your Needs

There is a wide array of APIs to power a variety of use cases. Our team is always seeking input from our partner ecosystem, and we encourage you to pass along feedback.

Cloud Based APIs

Architecture

API Overview Architecture Data Flow

 

Silver Spring Data Platform

The Data Platform APIs enable a new generation of applications by making high granularity sensor data easily available. The Data Platform provides a suite of REST-based APIs for solution development and IoT device data access. There are multiple APIs to power a variety of use cases. The API set includes device provisioning and querying, event provisioning and subscription through webhooks, observations (sensor data), provisioning, and querying among others.  You can run a simulation using the Data Platform APIs in Starfish Studio. More detail on the available Data Platform APIs and their use can be found at Data Platform APIs.

 

CoAP Gateway

The CoAP Gateway is a UDP-based Constrained Application Protocol (CoAP) interface that exposes a forward proxy for Read/Write access to devices on the SSN mesh network.

Users of this document should to be familiar with CoAP functionality. The CoAP Gateway functions as a standard CoAP-to-CoAP proxy and its usage primarily follows the CoAP standard. Therefore, it can be implemented with standard tools, such as the libcoap library for Linux and OS X or COAPSharp library for .NET.

To learn more about the CoAP API, refer to CoAP Gateway API Documentation.

 

Note: Starfish Studio is designed for using Data Platform APIs, and not the CoAP API.

 

End to End Solution 

Security

Authentication

Calls are secured using an OAuth token (API key). Each call must include an Authorization http header that specifies the token. All APIs use token is retreived from the tokens API included with Starfish Studio.  A token is obtained with a Client ID and Secret API key. Your client ID and Secret can be obtained from your developer account. Create an Account

Tokens

Once you have your Client ID and Secret, you can obtain a token by calling the "tokens" API replacing <your ClientID> and <your Secret> with the values provided through your Developer Portal account.  You can find more information about the tokens API and its use in the API View in Starfish Studio.

An example call using Curl is shown here:

 

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"clientId": "<your ClientID>", "clientSecret": "<your Secret>"}' 'https://api.data-platform.developer.ssni.com/api/tokens'

 

Upon successful client authentication, the authorization server returns the access token in the response. You can now make the actual query by providing the access token obtained from the response given in the previous step in the HTTP Authorization header.

Token Expiration

APIs can be called in any combination and any number of times with a valid token, however tokens are valid for a fixed time duration of 1 hour. A new token must be obtained upon expiration.