API do Firmou
A API que o seu sistema (ERP, CRM, o que for) usa para conversar com o Firmou: enviar documentos para assinatura, acompanhar o andamento e baixar o resultado.
Autenticação
Toda chamada exige um token de API no cabeçalho Authorization:
Authorization: Bearer frm_SEU_TOKEN_AQUI
O token é emitido pela tela Configurações › Tokens dentro do Firmou — a própria API não emite nem revoga tokens, de propósito: quem administra credencial é gente autenticada por sessão, não outro token. Veja o guia Autenticação.
Workspace
Cada token nasce amarrado a um workspace só, escolhido no momento da emissão. Todo documento criado ou consultado por este token pertence àquele workspace — não existe parâmetro para trocar de área numa chamada; quem precisa de mais de um workspace emite um token para cada.
Erros
Erros de validação vêm no formato padrão do Laravel:
{
"message": "A descrição do primeiro erro encontrado.",
"errors": {
"campo": ["A mensagem específica deste campo."]
}
}
Códigos de status usados nesta API:
| Código | Significado |
|---|---|
401 | Token ausente, inválido, revogado ou vencido |
403 | Conta sem plano ativo, ou conta encerrada |
404 | O recurso não existe para este token — inclusive quando existe para outro tenant ou outro workspace |
422 | Validação, ou regra de negócio recusou a operação |
Authentication
- HTTP: Bearer Auth
Token emitido em Configurações › Tokens, dentro do Firmou.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | frm_... |
Contact Suporte Firmou: URL: https://firmou.app