Aparência
API para o seu sistema
Onde fica: Menu › Loja de Plugins › API para o seu sistemaDesde a v1.3.0
Libera a chave e o aviso automático (webhook) para que o seu ERP crie documentos no ASSINA por chamada REST, acompanhe o andamento e baixe o PDF assinado. É também por aqui que ERPs próprios ou de terceiros se ligam.
Antes de começar
Observação
O webhook evita que o seu sistema precise ficar consultando: assim que o documento conclui, o ASSINA chama o endereço que você cadastrou. Se todas as tentativas falharem, o seu sistema ainda consegue pegar o resultado consultando o status.
Só o Administrador acessa. O seu sistema precisa de um endereço público para receber o webhook.
Passo a passo
- Abra a ficha em Loja de Plugins › API para o seu sistema › Configurar.
- Copie o Endpoint exibido na tela, com Copiar.
- Revele a Chave de API (X-API-Key) com Mostrar chave e copie. Trate como senha.
- Cadastre o Webhook de conclusão. Informe a URL do webhook (no seu ERP) e o Segredo do webhook. O selo mostra o estado: Ligada, Desligada — sem URL ou Desligada — sem Segredo.
- Clique em Salvar webhook. Depois use Testar conexão na ficha, que confere se o endereço de aviso responde, sem disparar evento nenhum.
- Para trocar a chave, clique em Gerar nova chave.
Regras que a tela aplica
Atenção
Gerar nova chave invalida a anterior na hora: os sistemas que usam a chave antiga param de funcionar. E o aviso nunca sai sem assinatura: URL sem segredo não é gravada como ligada.
- O corpo do aviso vem assinado com HMAC-SHA256 no cabeçalho
X-Assina-Signature: sha256=..., para o seu sistema confirmar a origem. - Cada empresa tem a sua chave. Também existe chave dedicada por integração, revogável.
O que acontece depois
Cada aviso fica registrado, com status, número de tentativas e erro. Na lista de documentos, em Links, o quadro Entregas de webhook permite Reenviar as que falharam. Os detalhes técnicos das chamadas estão em API externa.
Perguntas frequentes
Recebo o aviso, mas a assinatura não confere. Confirme que você usa o mesmo segredo cadastrado aqui e que calcula o HMAC sobre o corpo exato recebido.
Preciso de webhook? Não: você pode só consultar o status do documento.