Support Services

O Support Services é o módulo de monitoramento criado pela Sensedia para reportar métricas das APIs do Open Insurance Brasil à Susep.

Ele oferece um conjunto de APIs para expor dados de monitoramento e de saúde das APIs do ecossistema do Open Insurance. Tanto os participantes quanto o Diretório Central podem consumir esses dados de forma descomplicada!

As APIs que fazem parte deste módulo são as seguintes:

Status API

Obtém a descrição referente ao código de status retornado pelas APIs.

Outages API

Obtém a lista de indisponibilidades agendadas para os serviços.

Metrics API

Possibilita ao Diretório consultar estatísticas operacionais das APIs oferecidas pelas Sociedades Seguradoras. Assim é possível avaliar a qualidade dos serviços fornecidos ao usuário final.

Configuração

APIs Regulatórias

1. Fazer o download das APIs Regulatórias APIs Comuns e API Admin.

2. Fazer a importação dessas APIs para o Manager do API Management.
   Saiba como importar as APIs para o Manager.

3. Na janela modal, digitar um nome e versão para a API que será criada e clicar em SELECT FILE para selecionar a API baixada.
   Os formatos aceitos são JSON e YAML.

4. Preencher as informações básicas das APIs Regulatórias da seguinte forma:
   

   • [ Name ]: com a descrição que corresponda ao nome da API importada;

   • [ API Version ]: com o mesmo valor indicado na Susep.

APIs do Support Services

1. Fazer o download do swagger das APIs do Support Services (Outages e Downtimes). Salvar o arquivo com o nome: OPIN-Support-Services-addonsensedia.json;

2. Fazer a importação dessas APIs para o Manager do API Management;
   Saiba como importar as APIs para o Manager.

3. Na janela modal, clicar em [ SELECT FILE ] e selecionar o arquivo OPIN-Support-Services-addonsensedia.json para importá-lo;

4. Preencher as demais informações das APIs do Support Services da seguinte forma:
   

   1. [ Name ]: com a descrição OPIN-Support-Services-addonsensedia.json

   2. [ API Version ]: com o valor 1.0.0

   3. Clicar em [ SELECT FILE ]

   4. Selecionar o arquivo OPIN-Support-Services-addonsensedia.json

   5. Clicar em [ SAVE ]

Variáveis de ambiente

1. Expandir o item Virtual Hosts, no menu lateral esquerdo;

2. Selecionar a opção Environments;

3. Digitar na área de busca o environment TLS do Open Insurance;

4. Clicar no ícone editar, no canto direito.

Serão exibidas as variables maps existentes.
Expandir o map desejado ou criar um novo para adicionar as variáveis de ambiente conforme as tabelas abaixo:

Sandbox

Produção

Deployment environment TLS

É necessário fazer o deployment do environment TLS para cada API cadastrada.

1. No Manager do API Management, clicar em API Suite e em seguida clicar em API Overview;

2. No painel Environments, clicar em [ ADD ];

3. Na janela modal, selecionar o environment TLS;

4. Clicar em [ ADD ];

5. No painel Environments, mudar o status para Deployed.

Atualizado em 20/03/2023