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 de "chave API na mão" a um fluxo de assinatura incorporado em direto. Vamos mantê-lo simples, focar nas decisões e ligá-lo diretamente a trechos funcionais na documentação.
Procura o guia não-técnico? Clique aqui.
O que vai fazer
Modelar o isolamento de clientes com as Áreas de Trabalho (Workspaces)
Criar um Modelo (Template) 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,029 por envelope, teste com documentos reais, gratuito para que possa programar e testar de ponta a ponta.
Requisitos prévios
Chave API da empresa ou área de trabalho a partir do seu painel de controlo
Um PDF que possa converter num modelo (template)
Um local para executar código do servidor para geração de JWT e webhooks
Precisa de recordar o fluxo geral? Consulte o Guia de Configuração Completo.
1) Criar uma área de trabalho para cada cliente
As Áreas 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 de estilo SaaS sem fuga de dados entre clientes.
Útil: as definições de área de trabalho, como a cópia de e-mail e o fuso horário, são por área de trabalho.
2) Criar um modelo reutilizável
Os modelos contêm o PDF, além das funções e 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 ao vivo. Também pode criar a partir de um PDF simples, se preferir. A referência abrange destinatários, campos, lembretes e regras de validação.
Opcional: permitir que utilizadores empresariais 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, acione o envio.
5) Disponibilizar a assinatura dentro do seu produto ou via redirecionamento
Assinatura incorporada
Cada destinatário assina num URL exclusivo 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
Em alternativa, pode enviar os destinatários para a interface de assinatura alojada. Consulte o mesmo guia acima para obter detalhes.
6) Monitorizar tudo com webhooks
Oiç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, novas tentativas e uma lista de verificação 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.
Áreas de trabalho 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,029 por envelope.
O que se segue?
Ligar a sua primeira área de trabalho
Adicionar um modelo
Enviar o seu primeiro pedido
Escolher incorporação ou redirecionamento
Configurar webhooks
👉 Obter chave API - não é necessário 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.
