Pular para o conteúdo principal

Webhooks - Rest PKI Core

Você pode configurar sua conta no Rest PKI Core para que sua aplicação receba notificações de eventos. Os seguintes eventos são suportados atualmente:

Tipo do eventoDescrição
DocumentSignatureCompletedDisparado quando um documento é assinado e tem seu processamento concluído

Caso habilitadas, as notificações de eventos por webhook consistem em requisições HTTP POST com um WebhookEventModel em JSON. Consulte a Referência da API para a definição do schema do modelo.

Abaixo temos um exemplo de notificação do tipo DocumentSignatureCompleted:

{
	"type": "DocumentSignatureCompleted",
	"document": {
		"id": "3dfdd6f0-884e-4092-abed-00f18ea6716a",
		"key": "FUFYQ7SL6XKMBW9A",
		"formattedKey": "FUFY-Q7SL-6XKM-BW9A",
		"dateCreated": "2026-10-12T14:31:07.5310000-03:00",
		"subscriptionId": "6e1ffc5e-4c0a-4f5b-9a0f-2d1b8c0f7a41",
		"originalFile": {
			"name": "P100001-001.pdf",
			"mimeType": "application/pdf",
			"length": 101730,
			"url": "https://..."
		},
		"markedFile": null,
		"signedFile": {
			"name": "P100001-001.pdf",
			"mimeType": "application/pdf",
			"length": 273429,
			"url": "https://..."
		},
		"signatureType": "Pdf",
		"availableUntil": "2026-11-11T14:31:07.5310000-03:00",
		"signers": [
			{
				"certificate": {
					"thumbprint": "...",
					"thumbprintSHA256": "...",
					"subjectCommonName": "Pierre de Fermat:47363361886",
					"subjectDisplayName": "Pierre de Fermat",
					"subjectIdentifier": "47363361886",
					"emailAddress": "test@lacunasoftware.com",
					"organization": null,
					"organizationIdentifier": null
				},
				"date": "2026-10-12T14:31:41.2070000-03:00"
			}
		],
		"metadata": {},
		"signatureSessionIds": [
			"a9d1d2b7-0b0e-4d4b-8d4c-5b3a1f0c9e27"
		]
	}
}

O document é um DocumentModel, o mesmo modelo que GET api/documents/{id} retorna. O signatureType é Pdf, Cms ou Xml. A url de cada arquivo é um link temporário que baixa o arquivo sem a chave de API e expira em pouco tempo, normalmente uma hora; por isso, baixe o arquivo em vez de armazenar o link. Cada arquivo traz também contentType e location, cópias obsoletas de mimeType e url mantidas para clientes mais antigos, e content e blobToken, que vêm nulos; o exemplo os omite.

A sua aplicação deve responder com um código de status 2xx. Qualquer outra resposta, ou a falta de resposta, conta como uma notificação com falha.

Configurando os webhooks​

As notificações por webhook são configuradas por organização (subscription), no painel de controle da instância do Rest PKI Core (https://core.pki.rest/ na instância SaaS), por um usuário com o papel Administrador ou Gerente na organização:

  1. Autentique-se no painel de controle e clique em Configurações no menu lateral
  2. No quadro Configuração de webhook, na aba Configuração, ative Habilitar webhook
  3. Preencha a URL para a qual as requisições HTTP devem ser enviadas
  4. Escolha um Tipo de autenticação:
    • NoAuth: nenhuma credencial é enviada
    • Basic: preencha um Nome de usuário e uma Senha, enviados no header Authorization com o scheme Basic
    • Bearer: preencha o Token de Autenticação, enviado no header Authorization com o scheme Bearer
    • ApiKey: preencha o Token de Autenticação, enviado no header X-Api-Key
  5. Clique em Salvar
aviso

Com Basic, o Rest PKI Core codifica o nome de usuário e a senha em Base64 separadamente e os une com dois-pontos: o header é Authorization: Basic base64(usuário):base64(senha), e não o Base64 de usuário:senha descrito na RFC 7617. Um tratamento padrão de autenticação Basic o recusa; por isso, verifique o header você mesmo ou escolha Bearer ou ApiKey.

A aba Chamadas recentes lista as notificações enviadas, com o estado de cada uma, a hora da última tentativa e a resposta da sua aplicação.

Ver em Markdown