É um desenvolvedor e já tem a sua conta na Firma? Perfeito. Este guia leva-o de “chave API em mãos” para um fluxo de assinatura incorporado ao vivo. Vamos mantê-lo simples, focar em decisões e ligá-lo diretamente a fragmentos de trabalho na documentação.

À procura do guia não técnico? Clique aqui.

O que irá fazer

1. Modelar o isolamento do cliente com Espaços de Trabalho

2. Criar um Modelo reutilizável

3. Enviar um Pedido de Assinatura

4. Incorporar a experiência de assinatura ou redirecionar

5. Acompanhar tudo com Webhooks

Os preços são simples. São $0,029 por envelope, com os primeiros 25 envelopes gratuitos para que possa construir e testar de ponta a ponta.

Pré-requisitos

Chave API de empresa ou espaço de trabalho do seu painel

• Um PDF que possa transformar num modelo

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

Precisa de uma recapitulação sobre o fluxo geral? Veja o Guia Completo de Configuração.

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

Os Espaços de Trabalho oferecem a cada cliente um espaço privado e particionado com modelos, documentos e uso isolados. É a maneira mais limpa de construir uma separação multi-inquilino no 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: as configurações do espaço de trabalho, como cópia de e-mail e fuso horário, são por espaço de trabalho.

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

2) Criar um modelo reutilizável

Os modelos mantêm o PDF, além de papéis e campos, para que possa 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 projetem modelos dentro do seu aplicativo

Incorpore o editor de modelos 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 o seu modelo numa transação ao vivo. 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 usuários empresariais preencham detalhes e enviem através da sua UI

Incorpore 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

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 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}.

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

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

Redirecionar assinatura

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

6) Acompanhar 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. 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 ainda trabalham a partir de uma única API.

• Preços e lançamento. Comece com os envelopes gratuitos incluídos e, em seguida, vá para produção. Sem mínimos. $0,029 por envelope.

O que vem a seguir?

1. Conectar o seu primeiro espaço de trabalho

2. Adicionar um modelo

3. Enviar o seu primeiro pedido

4. Escolha incorporar ou redirecionar

5. Ligar webhooks

👉 Obtenha sua chave API agora - sem necessidade de cartão de crédito.