Tudo que a tela faz, a API também faz.
Mais de cem endpoints REST sobre todas as funcionalidades, com documentação navegável, token por empresa e webhooks assinados para o seu sistema saber na hora que alguém assinou.
O que você ganha
Se algum destes pontos é a sua rotina, este módulo é para você.
Não é recurso bonito de catálogo: cada item abaixo apareceu em operação real de cliente, e é o que o módulo tira do caminho.
O que dói hoje
- Integração que só cria documento e, para o resto, obriga alguém a abrir o navegador.
- Sistema que avisa por e-mail e deixa o ERP descobrindo por consulta repetida.
- Documentação incompleta, que transforma uma semana de integração em um mês.
Do começo ao documento na mão
Gere o token
Na própria empresa, sem depender de ninguém. Token de produção e de teste, copiável quando você quiser.
Chame a API
Bearer no cabeçalho e pronto. O documento pode ser identificado pelo id interno, pelo código público ou pela sua própria referência.
Receba os eventos
Cadastre a URL do seu sistema e escolha os eventos. Cada entrega vai assinada, para você conferir que veio daqui.
Acompanhe
Tela de entregas mostra o que foi enviado, o que falhou e quando será a próxima tentativa.
Os detalhes que fazem a diferença no dia a dia
Documentação navegável
Especificação OpenAPI 3.1 servida com o Scalar, com exemplos por endpoint.
Token por empresa
Guardado como hash, copiável quando preciso, com registro de quem copiou.
Entrega assinada
Assinatura HMAC-SHA256 no cabeçalho, para o seu servidor recusar evento falso.
Reentrega com espera crescente
Seis tentativas, de um minuto a doze horas, até o seu sistema responder.
Ambiente de teste
Token de teste para integrar sem mexer no que está valendo.
Limite por token
Controle de volume por token e registro de cada chamada, para medir o uso.
A parte que o time de TI pergunta
Este módulo não é só tela: ele existe inteiro na API, com os mesmos limites e as mesmas regras.
- Como está feito
- Isolamento rígido por empresa: o token só alcança os dados da empresa dele, e pedido com empresa_id de terceiro é recusado com 403.
- PUT substitui, PATCH mescla. DELETE inativa e preserva a prova.
- Mensagens de erro em português, dizendo o que corrigir — não só o código.
- Cabeçalho Authorization lido de várias fontes, para não quebrar em servidor compartilhado.
Endpoints deste módulo
// confira a assinatura do webhook antes de confiar no evento
$segredo = getenv("TECHPS_WEBHOOK_SEGREDO");
$corpo = file_get_contents("php://input");
$enviada = $_SERVER["HTTP_X_TECHPS_ASSINATURA"] ?? "";
$minha = hash_hmac("sha256", $corpo, $segredo);
if (!hash_equals($minha, $enviada)) {
http_response_code(401);
exit;
}
$evento = json_decode($corpo, true);O que costumam perguntar sobre este módulo
A API cobre o sistema todo ou só o envio?
O sistema todo: documentos, signatários, funcionários, setores, cargos, tipos, lotes com OCR, identificadores, certificados, webhooks, tokens, usuários, perfis, auditoria e consumo.
Como garanto que o webhook veio de vocês?
Cada entrega leva uma assinatura HMAC-SHA256 do corpo, calculada com o segredo do seu webhook. O exemplo ao lado é a verificação completa, em cinco linhas.
Dá para integrar sem mexer no ambiente de produção?
Sim. Gere um token de teste e integre contra ele. Quando estiver pronto, troque pelo token de produção.
Os módulos que trabalham junto com este
API e webhooks funcionando com um documento seu.
Na demonstração a gente usa um arquivo da sua empresa e monta o cenário que você vive hoje. Você sai da reunião sabendo exatamente o que muda na sua rotina.