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 ao vivo e incorporado. Vamos mantê-lo conciso, focar nas decisões e direcioná-lo diretamente para trechos funcionais na documentação.

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

O que você vai fazer

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 workspace do seu painel

• Um PDF que possa transformar em um template

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

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

1) Criar um workspace para cada cliente

Os Workspaces fornecem a cada cliente um espaço privado e particionado com templates, documentos e uso isolados. É a maneira mais limpa de construir uma separação multi-inquilinos 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

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

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

Útil: configurações de 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

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

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 funções e campos, assim pode enviar o mesmo documento muitas vezes com diferentes destinatários.

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

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

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

Opção A: Permitir que usuários projetem templates dentro do seu aplicativo

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

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

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

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

Gerar 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

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

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 o seu template em uma transação ao vivo. Você também pode criar a partir de um PDF bruto, se preferir. A referência cobre 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

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

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

Opcional: permitir que usuários empresariais preencham detalhes e enviem do seu UI

Incorporar o editor de pedidos de assinatura com um JWT de 7 dias.

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

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

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

Gerar 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

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

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

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

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

5) Entregar assinatura dentro do seu produto ou via redirecionamento

Assinatura embutida

Cada destinatário assina em uma URL única 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

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

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

Você irá 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

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

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

Redirecionamento de assinatura

Alternativamente, pode enviar destinatários para a interface de assinatura hospedada. Veja o mesmo guia acima para detalhes.

6) Acompanhe tudo com webhooks

Escutar 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 lista de verificação para produção.

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

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

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

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

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

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

Notas rápidas de arquitetura

• JWTs. Gerá-los no lado do servidor. Tokens de editor de template são de curta duração; tokens de editor de pedidos de assinatura expiram após 7 dias.

• Workspaces para SaaS. Manter clientes totalmente particionados. Seus operadores ainda trabalham a partir de uma única API.

• Preço e implementação. Comece com envelopes gratuitos incluídos, depois vá ao vivo. Sem mínimos. €0,029 por envelope.

O que vem a seguir?

1. Conectar o seu primeiro workspace

2. Adicionar um template

3. Enviar o seu primeiro pedido

4. Escolher entre incorporar ou redirecionar

5. Conectar webhooks

👉 Obter chave API - sem necessidade de cartão de crédito.