Configuring IEE REST APIs

The IEEIEE REST APIs are a collection of loosely coupled, independent REST APIs that are used by the Web UI UI as well as other IEE Core functionalities. These REST APIs rely on IEE Core libraries. The Web UI API installer installs these IEE REST APIs as Windows services.

After setting up the Web UI API, use the following procedure to configure the IEE REST APIs:

  1. Copy the ServerBootstrap.config file used by IEE core (available in C:\ProgramData\Itron\Enterprise Edition) and paste it into the installed API location:

    [API installation location]\CoreServices\Apis\ieeservices\config

  2. Export the certificate used to encrypt the ServerBootstrap as a .pfx file with the private key, and name the exported file certificate.pfx.

  3. Create a new file named secrets.env. In this file, type the password used to export the certificate.

  4. Place the new files (certificate.pfx and secrets.env) in [API installation location] \CoreServices\Apis\ieeservices\config.

Starting the IEE REST APIs

After configuring the IEE REST APIs, open Windows Services and start the Itron IEE Configuration Service, Itron IEE Gateway Service, Itron IEE Reading Service, Itron IEE StreamData Service, and Itron IEE SystemConfig Service.

Screenshot of the IEE REST APIs.

Confirming the IEE REST APIs

To confirm that the IEEIEE REST APIs are running, open the Swagger page for each service. For example, the Irton IEE StreamData REST API service is on port 10001: https://<machine-name>.com:10001/swagger/index.html

 

IEE Stream Data swagger page.

For each core IEE REST API, use the default port number indicated in the following table to view its Swagger page:

Table 111 IEE REST APIs

IEE REST API

Default port
IEE Reading REST API 6001
IEE Configuration REST API 7001
IEE Gateway REST API 9001
IEE StreamData REST API 10001

IEE System Configuration REST API

11001

IEE Identity Sync REST API

12000