Introduction

The Configuration Management Service (CMS) is an Itron microservice responsible for managing Distributed Intelligence (DI) edge application configurations and for distributing published changes to these configurations at endpoint scale. The CMS API offers edge application developers and utilities the ability to publish and automate configuration changes to their endpoint population within the DI ecosystem.

About this guide

This doucment provides explanations and diagrams about CMS to aid in understanding its uses. It also provides reference information, including specifications and code samples you can consult when using the CMS API. How-to guides are provided to outline practical application of the CMS, with prerequisites, ordered steps, and examples you can follow for guidance on publishing your own configuration changes.

Intended audience

This guide is intended for partners, utilities, and third-party edge application developers who are configuring their DI applications and injecting those configurations into meters.

Related documentation

Assumptions

This API guide and the information within are provided assuming that:

  • You are comfortable making web API calls using tools like Postman, cURL, or through HTTP libraries in your programming language of choice.
  • Your target edge application has passed through the DI partner certification program.
  • Your target tenant has the DI platform running, has installed the target edge application, and the application is running on some population of endpoints.
  • You are implementing a back-end service that will publish configuration changes through these API calls.

RESTful API

The CMS API conforms to the constraints of the representational state transfer (REST) architecture style, making it a RESTful API. The CMS API transfers its representation in the JavaScript Object Notation (JSON) format over HTTP.

API prerequisites

  • The agent/application is licensed and configured to run on the target tenant.

  • The target tenant must have an installed and running head end system (HES) and On-premises Hybrid Service (OHS).

  • Each request made using the CMS API requires a bearer token to authorize the request.

    • Developers must work with an Identity tenant administrator to create a client in Identify that uses the At least tenant writer client template.

    • A ClientID and ClientSecret is required to call the CMS APIs.

    • Provide the Client ID and ClientSecret to an Identity API call to get a Bearer Token that reflects their details. They make a call against the target tenant ID and the authorization system will check that they indeed have sufficient privileges to edit on the target tenant's behalf.

    • Bearer tokens expire, so they will need to be renewed.

  • The partner DI application and its features being configured must be uploaded into the Itron Enterprise Application Center (EAC) under the partner’s tenant and the app must be certified, production signed, and available in the application catalog.

  • The DI application has been downloaded to endpoints of the target tenant.

  • Licenses for the DI application have been sent to endpoints of the target tenant.

Production, stage, and test environments

The following are the base URLs for each Itron DI environment:

Prod USW. https://services.itrontotal.com

Prod CAC. https://services.itrontotal.ca

Prod AUE. https://services.itroneyva.com.au

Stage. https://services.itrontotalstage.com

Test2. https://servicestest2.itrontotaltest.com