Guias
Envie o seu primeiro fluxo de assinatura eletrónica rapidamente com a Firma: Um guia rápido para programadores
É programador e já tem a sua conta Firma? Perfeito. Este guia leva-o de "chave da API na mão" a um fluxo de assinatura incorporado e em funcionamento. Vamos mantê-lo simples, focar-nos nas decisões e ligá-lo diretamente a snippets funcionais na documentação.
Procura o guia não técnico? Clique aqui.
O que irá fazer
Modelar o isolamento de clientes com Espaços de Trabalho
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 que possa desenvolver e testar de ponta a ponta.
Pré-requisitos
Chave da API da empresa ou do espaço de trabalho a partir do seu painel de controlo
Um PDF que possa transformar num modelo
Um local para correr código de servidor para a geração de JWT e webhooks
Precisa de relembrar o fluxo geral? Consulte o Guia Completo de Configuração.
1) Criar um espaço de trabalho para cada cliente
Os Espaços de Trabalho 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-inquilino ao estilo SaaS sem fuga de dados entre clientes.
Útil: as definições do espaço de trabalho, como a cópia de e-mail e o fuso horário, são por espaço de trabalho.
2) Criar um modelo reutilizável
Os modelos contêm o PDF, bem como 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 do 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 cobre destinatários, campos, lembretes e regras de validação.
Opcional: permitir que utilizadores empresariais preencham detalhes e enviem a partir da sua interface
Incorpore o editor de pedidos de assinatura com um JWT de 7 dias.
Gere o JWT do lado do servidor.
4) Enviar o pedido de assinatura
Quando estiver pronto, acione 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 para 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 sobre arquitetura
JWTs. Gere-os do 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.
Espaços de Trabalho para SaaS. Mantenha os clientes totalmente particionados. Os seus operadores continuam a trabalhar a partir de uma única API.
Preços e implementação. 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 espaço de trabalho
Adicionar um modelo
Enviar o seu primeiro pedido
Escolher incorporação ou redirecionamento
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.
