Quote – Webhook v1.1.0

APIS – Cotação Firme

Nas APIs de cotação, a instituição receptora de dados envia uma notificação a SPOC informando que ocorreu uma mudança de estado no recurso, a iniciadora deverá consultar o recurso para obter mais informações.

Caso de Uso

Os casos de uso fornecem uma visão clara e estruturada de quando o Webhook será acionado e o fluxo geral da máquina de estado

Notificação sobre cotação

Os eventos que acionarão notificações via Webhook, será a mudança do status da cotação para REJECTED e ACCEPTED.

Máquina de Estados – Cotação

Open

Diagrama de sequência

No diagrama de exemplo abaixo, é possível identificar como será o comportamento da SPOC no processo de consulta de uma cotação. A receptora envia uma notificação à instituição iniciadora informando que ocorreu uma mudança significativa da máquina de estados de cotação e que ela deverá consultar a cotação para obter mais informações.

Cenário de cotação aceita

Open

Cenário de cotação rejeitada

Conteúdo do Payload/URL

O payload será composto pela informação do timestamp do momento da alteração do estado da cotação:

URL

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

As Receptoras/Transmissoras, precisam construir a URI de notificação da seguinte forma:

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

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 receptora, poderá utilizar os endpoints de consulta para obter informações sobre o andamento de uma determinada cotação.

• Endpoints de consulta do estado da cotação patrimonial:

• Endpoints de Consulta do estado da cotação auto:

Orientações para as receptoras

• Orientações para as receptoras:

  • A receptora fará no máximo 3 tentativas de notificação para a iniciadora:

  • A segunda e a terceira tentativas só ocorrerão em caso de falha;

  • A primeira tentativa de notificação do evento, pela receptora, deverá ocorrer em até 1,5 segundo após o evento;

  • A segunda tentativa deverá ocorrer 10 segundos após a falha da primeira tentativa;

  • A terceira tentativa deverá ocorrer 60 segundos após a falha da segunda tentativa;