Guias
Envie o seu primeiro fluxo de assinatura eletrónica rapidamente com a Firma: Um guia rápido para programadores
É um programador e já tem a sua conta Firma? Perfeito. Este guia leva-o desde a “chave API na mão” até um fluxo de assinatura incorporado e em tempo real. Vamos mantê-lo simples, focado em decisões, e ligá-lo diretamente a snippets funcionais na documentação.
Procura o guia não técnico? Clique aqui.
O que vai fazer
Modelar o isolamento de clientes com Workspaces
Criar um Modelo reutilizável
Enviar um Pedido de Assinatura
Incorporar a experiência de assinatura ou redirecionar
Acompanhar tudo com Webhooks
O preço é simples. São €0.049 por envelope, teste com documentos reais, gratuito para poder construir e testar de ponta a ponta.
Pré-requisitos
Chave API da empresa ou do workspace a partir do seu painel de controlo
Um PDF que possa transformar num modelo
Um local para correr código de servidor para geração de JWT e webhooks
Precisa de recordar o fluxo geral? Consulte o Guia Completo de Configuração.
1) Criar um workspace para cada cliente
Os Workspaces dão a cada cliente um espaço privado e particionado com modelos, documentos e utilização isolados. É a forma mais limpa de construir uma separação multi-tenant ao estilo SaaS sem fuga de dados entre clientes.
Útil: as configurações de workspace, como a cópia de e-mail e o fuso horário, são por workspace.
2) Criar um modelo reutilizável
Os modelos contêm o PDF mais as funções e os campos, para que possa enviar o mesmo documento muitas vezes com destinatários diferentes.
Opção A: Permitir que os utilizadores desenhem modelos dentro da sua aplicação
Incorpore o editor de modelos com um JWT de curta duração.
Gere o token no lado do servidor.
3) Criar o pedido de assinatura
Transforme o seu modelo numa transação ativa. Também pode criar a partir de um PDF simples, se preferir. A referência aborda destinatários, campos, lembretes e regras de validação.
Opcional: permitir que utilizadores comerciais preencham detalhes e enviem a partir da sua interface de utilizador
Incorpore o editor de pedidos de assinatura com um JWT de 7 dias.
Gere o JWT no lado do servidor.
4) Enviar o pedido de assinatura
Quando estiver pronto, desencadeie o envio.
5) Disponibilizar a assinatura dentro do seu produto ou via redirecionamento
Assinatura incorporada
Cada destinatário assina num URL único que segue este padrão:
https://app.firma.dev/signing/{signing_request_user_id}.
Irá obter o signing_request_user_id a partir da API.
Redirecionamento de assinatura
Alternativamente, pode enviar os destinatários para a interface de assinatura alojada. Consulte o mesmo guia acima para obter detalhes.
6) Acompanhar tudo com webhooks
Fique atento a eventos como criado, enviado, visualizado, assinado e concluído para atualizar o seu sistema em tempo real. O guia inclui verificação HMAC, rotação, tentativas e uma checklist de produção.
Notas rápidas de arquitetura
JWTs. Gere-os no lado do servidor. Os tokens do editor de modelos são de curta duração; os tokens do editor de pedidos de assinatura expiram após 7 dias.
Workspaces para SaaS. Mantenha os clientes totalmente particionados. Os seus operadores continuam a trabalhar a partir de uma única API.
Preços e lançamento. Comece com os envelopes gratuitos incluídos e depois passe para o ambiente real. Sem mínimos. €0.049 por envelope.
O que se segue?
Ligar o seu primeiro workspace
Adicionar um modelo
Enviar o seu primeiro pedido
Escolher incorporar ou redirecionar
Configurar webhooks
👉 Obter chave API - sem necessidade de cartão de crédito.
Artigos relacionados
A nossa plataforma foi projetada para capacitar empresas de todos os tamanhos a trabalhar de forma mais inteligente e alcançar seus objetivos com confiança.
