Introduction

REST APIs exposed by the Third-Party Gateway allow a utility customer to sign up for a Distributed Intelligence (DI)-related program with a utility company, using the utility's customer portal. When a utility customer signs up for a program, the customer portal calls into the Third-Party Gateway to initiate the relevant application downloads and licensing to the utility customer’s meter. The Third-Party Gateway is responsible for the following communication points:

• Provide communication between the customer portal and DI services.

• Receive requests from the customer portal and forward them to the Itron Enterprise Application Center (EAC).

• Manage request, response, and notification service bus queues.

This document is intended for the following audiences:

• Experienced Itron product implementation teams

• System integrators

• Application developers

• Product managers and engineering teams responsible for defining Distributed Intelligence (DI) requirements and developing and testing functionality

Related documentation

• Configuration Management Service (CMS) API Guide

• Distributed Intelligence Developer Key (DDK) Meter Get Started Guide

• Distributed Intelligence (DI) Admin Documentation and Release Notes

• Distributed Intelligence (DI) Software Development Kit (SDK) Documentation and Release Notes

• Itron Enterprise Application Center (EAC) User Guide

Prerequisites

Before you start, contact Itron customer support to obtain the following:

• Itron Identity credentials, including the client ID and client secret. Itron Identity services provide authentication, authorization, and accounting (AAA) protocols. For more information, see Itron Identity Service.

• The tenant ID for the utility company hosting endpoints and networking infrastructure.

• Sample code, provided in a .zip.

• A collection of pre-built requests, provided in a Postman Collection.

Postman

Import the Postman Collection that Itron provided into Postman. The following image shows the imported files.

There are Postman training videos availalbe on YouTube:

• Intro to Postman & Postman Collections

• Environments with Postman

RESTful API

The Third-Party Gateway API conforms to the constraints of the representational state transfer (REST) architecture style, making it a RESTful API. It transfers its representation in the Javascript Object Notation (JSON) format over HTTP.

Assumptions

• The Third-Party Gateway owns and manages the service bus used in the solution.

• The Third-Party Gateway owns and manages service bus queues for request, response, and notification.

• The notification service bus queue that acts as the channel of communication between the Itron Enterprise Application Center (EAC) and the customer portal is created per tenant.

• The Distributed Intelligence DevOps team manages the Third-Party Gateway. Depending on the time of day, different members of the team manage it.