Envie o seu primeiro fluxo de assinatura eletrónica rapidamente com a Firma: Um guia rápido para programadores

É um desenvolvedor e já tem a sua conta Firma? Perfeito. Este guia leva-o de "chave API na mão" para um fluxo de assinatura em tempo real. Vamos mantê-lo enxuto, focar nas decisões e ligar-te diretamente a fragmentos funcionais na documentação.

Procurando pelo guia Não técnico? Clique aqui.

O que você fará

1. Modelar isolamento de clientes com Workspaces

2. Criar um Template reutilizável

3. Enviar um Pedido de Assinatura

4. Incorporar a experiência de assinatura ou redirecionar

5. Acompanhar tudo com Webhooks

A precificação é simples. É $0.029 por envelope, com os seus primeiros 25 envelopes gratuitos para que possa construir e testar de ponta a ponta.

Pré-requisitos

Chave API da empresa ou do espaço de trabalho do teu painel

• Um PDF que podes transformar em um modelo

• Um lugar para executar código de servidor para geração de JWT e webhooks

Precisa de uma atualização sobre o fluxo geral? Veja o Guia de Configuração Completa.

1) Criar um espaço de trabalho para cada cliente

Os Workspaces dão a cada cliente um espaço privado e particionado com modelos, documentos e uso isolados. É a maneira mais limpa de construir separação multi-inquilino estilo SaaS sem vazamento de dados entre clientes.

Create a workspace
https://docs.firma.dev/api-reference/v01.00.01/workspaces/create-a-new-workspace

Útil: configurações do workspace como cópia de e-mail e fuso horário são por workspace.

Workspace settings guide
https://docs.firma.dev/guides/workspace-settings

2) Criar um template reutilizável

Os templates contêm o PDF além de papéis e campos, assim você pode enviar o mesmo documento várias vezes com destinatários diferentes.

Create Template (API)
https://docs.firma.dev/api-reference/v01.00.01/templates/create-template

Opção A: Permitir que os usuários desenhem modelos dentro do seu aplicativo

Incorpore o editor de templates com um JWT de curta duração.

Embeddable template editor (guide)
https://docs.firma.dev/guides/embeddable-template-editor

Gere o token no lado do servidor.

Generate JWT for template embedding
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-embedding-templates

3) Criar o pedido de assinatura

Transforme seu modelo em uma transação em tempo real. Você também pode criar a partir de um PDF bruto, se preferir. A referência abrange destinatários, campos, lembretes e regras de validação.

Create Signing Request
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/create-signing-request

Opcional: permitir que os utilizadores empresariais preencham detalhes e enviem a partir da sua IU

Incorpore o editor de pedido de assinatura com um JWT de 7 dias.

Embeddable signing request editor (guide)
https://docs.firma.dev/guides/embeddable-signing-request-editor

Gere o JWT no lado do servidor.

Generate JWT for signing request editor
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-signing-request

4) Enviar o pedido de assinatura

Quando estiver pronto, acione o envio.

Send signing request
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/send-signing-request

5) Entregar uma assinatura dentro do seu produto ou por redirecionamento

Assinatura incorporada

Cada destinatário assina num URL único que segue este padrão:

https://app.firma.dev/signing/{signing_request_user_id}.

Embeddable signing (iframe pattern and tips)
https://docs.firma.dev/guides/embeddable-signing

Você buscará o signing_request_user_id da API.

Get signing request users
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/get-signing-request-users

Assinatura por redirecionamento

Alternativamente, você pode enviar destinatários para a interface de assinatura hospedada. Consulte o mesmo guia acima para mais detalhes.

6) Rastrear tudo com webhooks

Ouça eventos como criado, enviado, visualizado, assinado e concluído para atualizar seu sistema em tempo real. O guia inclui verificação HMAC, rotação, tentativas e uma lista de verificação de produção.

Webhooks guide
https://docs.firma.dev/guides/webhooks

Create webhook (API)
https://docs.firma.dev/api-reference/v01.00.01/webhooks/create-webhook

Notas rápidas de arquitetura

• JWTs. Gere-os no lado do servidor. Tokens de editor de modelo têm curta duração; tokens de editor de pedido de assinatura expiram após 7 dias.

• Workspaces para SaaS. Mantenha os clientes totalmente particionados. Os seus operadores ainda trabalham a partir de uma única API.

• Preços e lançamento. Comece com os envelopes gratuitos incluídos, depois vá ao vivo. Sem mínimos. $0.029 por envelope.

O que vem a seguir?

1. Conecte o seu primeiro espaço de trabalho

2. Adicione um modelo

3. Envie o seu primeiro pedido

4. Escolha incorporar ou redirecionar

5. Conecte webhooks

👉 Obtenha a sua chave API agora - nenhum cartão de crédito necessário.