Products – Webhook v1.1.0

Owned by Secretariado Open Insurance
Last updated: ago. 29, 2024
2 min read

  • capitalization-title

Na API webhook (endpoint de produto), a seguradora envia uma notificação a SPOC informando que ocorreu uma alteração no payload de produto da Fase 1 que são utilizados no processo de cotação, logo, a iniciadora deverá consultar a API de produtos da seguradora para manter os campos atualizados em sua base.

Obrigatoriedade de notificação

A deliberação sobre a obrigatoriedade de notificação da alteração da API de produtos pelas seguradoras se teve através de discussões realizadas no GT de Infraestrutura e Tecnologia, pelo fato de que as seguradoras precisam comunicar todas as SPOCs do ecossistema, para evitar acesso excessivo via polling.

Já a SPOC por sua vez, ao entrar no ecossistema, deverá consumir a API de produtos de todas as seguradoras que o possuam, e confirmar o consumo via Webhook.

  • Seguradora: Notificar todas as SPOCs, quando houver alteração em seus produtos, ou entrar pela primeira vez no ecossistema (Obrigatório)

  • SPOC: Consumir os dados de produtos de todas as seguradoras ao entrar pela primeira vez no ecossistema, ou quando for recebida notificação via webhook (Obrigatório)

Para mais detalhes vide diagrama de sequência de manutenção da API de produtos na Iniciadora.

Conteúdo do Payload/URL

O payload será composto pela informação do timestamp do momento da alteração dos campos dinâmicos

image-20240829-134539.png

URL

As URLs do ecossistema são formadas com a configuração abaixo:
<host> / <string> / <api> / <versão> / <recurso>

As seguradoras precisam construir a URI de notificação da seguinte forma:

image-20240829-134625.png

Quando habilitar a funcionalidade de Webhook para as APIs de Produto, a iniciadora deverá estar apta a receber notificações no seguinte endereço:

·       https://insurSpocExemplo.com/open-insurance/webhook/[Versão do Webhook]/product-services/{authorizationServerId}/{VersionApi}/capitalization-title

Segurança

  • Todos os endpoints do Webhook utilizam-se de mTLS para autenticação, não possuem scopes e permissions específicos de segurança. Toda a segurança é feita via certificado(mTLS – BRCAC).

  • Não será necessário a assinatura do webhook, pois não vai haver dados sensíveis no conteúdo do Payload.

Orientação em caso de falha

Em caso de falha de notificação a SPOC deve:

  • A iniciadora, ao perceber que não está recebendo as notificações oriundas da seguradora, poderá utilizar os endpoints de consulta para obter informações das alterações efetuadas no payload.

  • Endpoints de consulta de produtos:

GET/capitalization-title