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 API na mão” até a um fluxo de assinatura incorporado em produção. Vamos mantê-lo conciso, focar nas decisões e ligar diretamente a exemplos prontos a usar na documentação.

Procura o guia Não técnico? Clique aqui.

O que vai fazer

1. Modelar o 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

O preço é simples. São €0.029 por envelope, com os primeiros 25 envelopes grátis para que possa construir e testar de ponta a ponta.

Pré-requisitos

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

• Um PDF que possa transformar num template

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

Precisa de um resumo do 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 templates, documentos e utilização isolados. É a forma mais limpa de criar separação multi-inquilino ao estilo SaaS sem fuga 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: definições do workspace como o texto dos emails e o fuso horário são específicas de cada workspace.

Guia de definições do workspace
https://docs.firma.dev/guides/workspace-settings

Guia de definições do workspace
https://docs.firma.dev/guides/workspace-settings

Guia de definições do workspace
https://docs.firma.dev/guides/workspace-settings

2) Criar um template reutilizável

Os templates incluem o PDF, os papéis e os campos, para que possa enviar o mesmo documento muitas vezes com destinatários diferentes.

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

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

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

Opção A: Deixe os utilizadores criar templates dentro da sua app

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

Editor de templates incorporável (guia)
https://docs.firma.dev/guides/embeddable-template-editor

Editor de templates incorporável (guia)
https://docs.firma.dev/guides/embeddable-template-editor

Editor de templates incorporável (guia)
https://docs.firma.dev/guides/embeddable-template-editor

Gere o token no servidor.

Gerar JWT para incorporação de templates
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-embedding-templates

Gerar JWT para incorporação de templates
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-embedding-templates

Gerar JWT para incorporação de templates
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 numa transação ativa. Também pode criar a partir de um PDF em bruto, se preferir. A referência cobre destinatários, campos, lembretes e regras de validação.

Criar pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/create-signing-request

Criar pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/create-signing-request

Criar pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/create-signing-request

Opcional: permita que utilizadores de negócio preencham os detalhes e enviem a partir da sua interface

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

Editor incorporável do pedido de assinatura (guia)
https://docs.firma.dev/guides/embeddable-signing-request-editor

Editor incorporável do pedido de assinatura (guia)
https://docs.firma.dev/guides/embeddable-signing-request-editor

Editor incorporável do pedido de assinatura (guia)
https://docs.firma.dev/guides/embeddable-signing-request-editor

Gere o JWT no servidor.

Gerar JWT para o editor do pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-signing-request

Gerar JWT para o editor do pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-signing-request

Gerar JWT para o editor do pedido de assinatura
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, dispare o envio.

Enviar pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/send-signing-request

Enviar pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/send-signing-request

Enviar pedido de assinatura
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}.

Assinatura incorporável (padrão iframe e dicas)
https://docs.firma.dev/guides/embeddable-signing

Assinatura incorporável (padrão iframe e dicas)
https://docs.firma.dev/guides/embeddable-signing

Assinatura incorporável (padrão iframe e dicas)
https://docs.firma.dev/guides/embeddable-signing

Vamos obter o signing_request_user_id a partir da API.

Obter utilizadores do pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/get-signing-request-users

Obter utilizadores do pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/get-signing-request-users

Obter utilizadores do pedido de assinatura
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/get-signing-request-users

Assinatura por redirecionamento

Em alternativa, pode enviar os destinatários para a interface de assinatura alojada. Consulte o mesmo guia acima para mais 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, novas tentativas e uma lista de verificação de produção.

Guia de webhooks
https://docs.firma.dev/guides/webhooks

Guia de webhooks
https://docs.firma.dev/guides/webhooks

Guia de webhooks
https://docs.firma.dev/guides/webhooks

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

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

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

Notas rápidas de arquitetura

• JWTs. Gere-os no servidor. Os tokens do editor de templates são de curta duração; os tokens do editor do pedido de assinatura expiram ao fim de 7 dias.

• Workspaces para SaaS. Mantenha os clientes totalmente separados. Os seus operadores continuam a trabalhar a partir de uma única API.

• Preços e lançamento. Comece com os envelopes grátis incluídos e depois coloque em produção. Sem mínimos. €0.029 por envelope.

O que se segue?

1. Ligue o seu primeiro workspace

2. Adicione um template

3. Envie o seu primeiro pedido

4. Escolha incorporação ou redirecionamento

5. Configure webhooks

👉 Obter chave API - não é necessário cartão de crédito.