Support Services

Support Services provides a set of APIs to expose health and monitoring data from the Open Insurance ecosystem APIs. It offers this data in an uncomplicated way for participants to consume, as well as for the Central Directory.

Features

• Traffic Limits: the amount of requests per second that the APIs must support;

• Performance: response time for each request, varying according to the API's priority rating;

• Availability: minimum requirements that the Products and Services, Channels, and Environment Status APIs must meet. Availability is checked by API status.

Setup

Regulatory APIs

1. Download the Regulatory APIs Common APIs e Admin API.

2. Import these APIs into the API Manager.
   Learn how to import the APIs into Manager.

3. In the modal window, enter a name and version for the API that is to be created and click SELECT FILE to select the downloaded API.
   and The supported formats are JSON and YAML.

4. Fill in the basic information for the Regulatory APIs as follows:
   

   • [ Name ]: with the description that matches the name of the imported API;

   • [ API Version ]: with the same value indicated at Susep;

Support Services APIs

1. Download the Support Services (Outages e Downtimes) API swagger.Save the file with the name: OPIN-Support-Services-addonsensedia.json

2. Import these APIs into the API Manager.
   Learn how to import the APIs into Manager.

3. In the modal window, click [ SELECT FILE ] and select the file OPIN-Support-Services-addonsensedia.json to import it.

4. Fill in the remaining Support Services API information as follows:
   

   1. [ Name ]: with the description OPIN-Support-Services-addonsensedia.json

   2. [ API Version ]: with the value 1.0.0

   3. Click [ SELECT FILE ]

   4. Select the file OPIN-Support-Services-addonsensedia.json

   5. Click [ SAVE ]

Environment variables

1. Expand the Virtual Hosts item in the left side menu;

2. Select the option Environments;

3. Type in the search area the Open Insurance TLS environment;

4. Click the edit icon in the right corner.

The existing variable maps will be displayed.
Expand the desired map or create a new one to add the environment variables according to the tables below:

Sandbox

Production

Deployment TLS environment

You must deploy the TLS environment for each registered API

1. In the API Management, click API Suite, and then click API Overview;

2. In the Environments panel, click [ ADD ];

3. In the modal window, select TLS environment;

4. Click [ ADD ];

5. In the Environments panel, change the status to Deployed.