Gestão de Webhooks
Este módulo permite que uma GCC cadastre e gerencie webhooks HTTP para receber eventos relevantes da PGCC em tempo real.
Como usar
Para usar este serviço, o cliente deve cadastrar uma URL da API que receberá requisições conforme explicado na documentação do módulo de administração de webhooks seguinte: Documentação do Serviço.
Eventos considerados
Dois eventos são considerados para o acionamento do webhook:
- Atualizações do estado de pedidos de consentimento de interesse da GCC
- Atualizações do estado do credenciamento de usuários vinculados à GCC
Estado do pedido de consentimento
O endpoint cadastrado pela GCC receberá uma requisição HTTP com o método POST apresentando no corpo da resposta um JSON do seguinte formato:
{
"tipo": "CONSENTIMENTO",
"dataResposta": "2025-03-20T13:15:46.512Z",
"cpf": "12345678901",
"cnpj": "12345678000195",
"idConsentimento": "123",
"idConsentimentoPdc": "a8380d2e-d667-46cc-ab94-e3dfe338f981",
"idTemplateCredencia": "752024-00001",
"status": "REVOGADO"
}
Como o consentimento pode ser manipulado por diferentes entidades (Usuários,Anuentes, Gcc's e Titulares), pode ser que o evento de consentimento recebido pela Gcc não tenha sido originado por ela mesma. Dessa forma, a Gcc deve vincular o evento recebido por meio do campo idConsentimentoPdc com o seu próprio controle de consentimentos. O campo idConsentimentoPdc é o identificador único do consentimento no sistema da PDC e deve ser utilizado para esse vínculo. Lembrando que o idConsentimentoPdc é gerado pela PDC no momento da criação do consentimento e esse valor permanece o mesmo durante todo o ciclo de vida do consentimento (independente de quem manipule o consentimento). O campo idConsentimento é um identificador interno da Gcc para controle do consentimento e pode variar de Gcc para Gcc.
O evento do estado do consentimento sempre refletirá o estado mais recente do consentimento.
Estado do credenciamento dos usuários
Obs.: Este evento está planejado para versões futuras
O endpoint cadastrado pela GCC receberá uma requisição HTTP com o método POST apresentando no corpo da resposta um JSON do seguinte formato:
{
"tipo": "CREDENCIAMENTO",
"idVinculoUsuario": 0,
"numeroInscricaoGcc": "string",
"numeroInscricaoUsuario": "string",
"nomeUsuario": "string",
"dataInclusaoVinculo": "string",
"dataDesativacaoVinculo": "string",
"numeroSolicitacaoUsuario": "string",
"itemFaturador": "string",
"descricaoServicoNatureza": "string",
"situacaoSolicitacaoUsuario": "string",
"isLiberadoProducao": true,
"isContratoVigente": true,
"isDocumentoAutorizadorVigente": true,
"isAcessoBloqueado": true,
"ativo": true,
"situacaoVinculo": "PENDENTE",
"deAcordo": "PENDENTE",
"casosUso": [
{
"idTemplateCredencia": "string",
"nome": "string"
}
],
"evento": {
"dataRegistroEvento": "string",
"tipoEvento": 0,
"descricaoEvento": "string",
"numeroInscricaoUsuarioResponsavel": "string",
"nomeUsuarioResponsavel": "string",
"tipoUsuarioResponsavel": "string"
}
}
Caso o endpoint da GCC retornar um código HTTP 2XX, o evento será considerado como recebido. Caso contrário, a requisição será reenviada até o recebimento com sucesso da informação ou cancelada depois de um número de tentativas.