Support Services

Para o ecossistema de Open Insurance, é muito importante que métricas e dados relacionados ao monitoramento e saúde das APIs sejam disponibilizados aos participantes e também ao Diretório Central. Para isso, existem mecanismos de coleta de dados em tempo real, que devem ser implementados pelas Sociedades Seguradoras para atender às especificações do Open Insurance Brasil. A funcionalidade de Support Services abstrai a complexidade em expor dados de monitoramento e traz um conjunto de APIs prontas que tem como principal objetivo atender à regulação da Susep.

Features do Support Services

Devem ser observados na implementação das APIs do Open Insurance:

  • Limites de Tráfego: quantidade de requisições por segundo que as APIs deverão suportar;

  • Desempenho: tempo de resposta de cada requisição, variando de acordo com a classificação de prioridade da API;

  • Disponibilidade: requisitos mínimos que as APIs “Produtos e Serviços”, “Canais de Atendimento” e “Situação do Ambiente” deverão satisfazer (verificada pela API status).

Informações oficiais Open Insurance Brasil.

Configuração do Support Services

Preparando o ambiente

APIs Regulatórias

  1. Inicialmente, faça o download das APIs regulatórias (Comuns e Admin), clicando em:
    APIs Comuns e API Admin

  2. Em seguida, faça a importação dessas APIs para o Manager do API Platform.
    Para saber como importar APIs para o Manager, clique aqui.

  3. Na janela modal, digite um nome e versão para a API que será criada e clique em SELECT FILE para escolher o arquivo de sua máquina para importar.
    Os formatos aceitos são JSON e YAML.

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

    • O campo Name deve ser preenchido com o valor que corresponda à API que está sendo importada;

    • O campo API Version deve ser preenchido de acordo com o valor informado pela Susep;

APIs do Support Services

  1. Faça o download do arquivo das APIs do Support Services (Outages e Downtimes) clicando aqui e salve-o com o seguinte nome
    OPIN-Support-Services-addonsensedia.json

  2. Em seguida, faça a importação dessas APIs para o Manager do API Platform.
    Para saber como importar APIs para o Manager, clique aqui.

  3. Na janela modal, clique em SELECT FILE e selecione local do arquivo OPIN-Support-Services-addonsensedia.json para importá-lo.

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

    1. Para o campo Name, o valor OPIN-Support-Services-addonsensedia.json

    2. Para o campo API Version, o valor 1.0.0

    3. Clique em SELECT FILE

    4. Selecione o local do arquivo OPIN-Support-Services-addonsensedia.json

    5. Clique em SAVE

import openapi

Configuração das variáveis de ambiente

  1. No menu lateral esquerdo do API Platform, expanda o item Virtual Hosts

  2. Selecione a opção Environments

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

  4. Clique em editar, no canto direito

variaveis ambiente

Serão exibidas as variables maps existentes. Expanda o map desejado, ou crie um novo, e adicione as variáveis de ambiente conforme as tabelas abaixo:

Produção

Nome Valor

opin-outages-backend

https://opin-outages-ms.sensedia.com

opin-status-backend

https://opin-status-backend.sensedia.com

opin-metrics-backend

https://opin-metrics-backend.sensedia.com

opin-status-collector

https://opin-status-collector.sensedia.com

opin-metrics-collector

https://opin-metrics-collector.sensedia.com

opin-ob-apis

https://opin-ob-apis.sensedia.com

opin-ob-clients

https://opin-ob-clients.sensedia.com

Após adicionar todas as variáveis, clique em UPDATE e em seguida clique em SAVE.

Deployment do environment TLS

Para cada API cadastrada será necessário fazer o deployment do environment TLS.

deployment TLS

  1. No Manager do API Platform, clique em API Suite e em seguida clique em API Overview.

  2. No painel Environments, clique em ADD

  3. Na janela modal, selecione o environment TLS

  4. Clique em ADD

  5. Novamente no painel Environments, mude o status para Deployed

Será exibida a mensagem Successfully deployed! no canto superior direito.

Thanks for your feedback!
EDIT
How useful was this article to you?