API Overview

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

Find Your Solution Today. Create an Account

This page provides a high-level overview of the API options and setups available to developers who partner with Itron. 

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
  • Querying
  • and more 

 

You can run a simulation using the Data Platform APIs in Starfish Studio. More details on the available Data Platform APIs and their use can be found at Data Platform APIs.

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 share feedback.

Cloud Based APIs Architecture

 

 

 

MQTT Client

Message Queuing Telemetry Transport (MQTT) is a Client Server publish/subscribe messaging transport protocol. A central service called an MQTT Broker allows clients to connect and either publish or subscribe to events on "topics".  This decouples the producers of data from the consumers of data - one or more consumers have a subscription to a message topic and receive those messages but they do not need to know the source of the messages. 

The Itron back office includes an MQTT broker that allows applications to publish messages on topics and other applications to subscribe to messages on particular topics. Itron uses a Java based enterprise called HiveMQ.

To learn more about MQTT in the context of Itron products and solutions, see MQTT Overview and MQTT API and Client Integration documentation.

MQTT Subscription Flow

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 Itron Networked Solutions mesh network.

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.

CoAP Subscription Flow

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 tokens are retreived from the token's 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 the Account Settings tab in My Account Overview. If you don't already have one, you can 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.itron.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 one hour. A new token must be obtained upon expiration.