Thanks for your feedback!
EDIT
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
-
Inicialmente, faça o download das APIs regulatórias (Comuns e Admin), clicando em:
APIs Comuns e API Admin -
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. -
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. -
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
-
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 -
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. -
Na janela modal, clique em SELECT FILE e selecione local do arquivo OPIN-Support-Services-addonsensedia.json para importá-lo.
-
Preencha as demais informações das APIs do Support Services da seguinte forma:
-
Para o campo Name, o valor OPIN-Support-Services-addonsensedia.json
-
Para o campo API Version, o valor 1.0.0
-
Clique em SELECT FILE
-
Selecione o local do arquivo OPIN-Support-Services-addonsensedia.json
-
Clique em SAVE
-
Configuração das variáveis de ambiente
-
No menu lateral esquerdo do API Platform, expanda o item Virtual Hosts
-
Selecione a opção Environments
-
Digite na área de busca o environment TLS do Open Insurance
-
Clique em editar, no canto direito
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:
Sandbox
| Nome | Valor |
|---|---|
opin-outages-backend |
|
opin-status-backend |
|
opin-metrics-backend |
|
opin-status-collector |
|
opin-metrics-collector |
|
opin-ob-apis |
|
opin-ob-clients |
Produção
| Nome | Valor |
|---|---|
opin-outages-backend |
|
opin-status-backend |
|
opin-metrics-backend |
|
opin-status-collector |
|
opin-metrics-collector |
|
opin-ob-apis |
|
opin-ob-clients |
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.
-
No Manager do API Platform, clique em API Suite e em seguida clique em API Overview.
-
No painel Environments, clique em ADD
-
Na janela modal, selecione o environment TLS
-
Clique em ADD
-
Novamente no painel Environments, mude o status para Deployed
Será exibida a mensagem Successfully deployed! no canto superior direito.