Como Começar

Comece a usar o TapSign em poucos minutos. Este guia mostra como configurar sua conta, gerar a chave de API e enviar seu primeiro documento para assinatura.

1. Crie sua conta

Acesse tapsign.com.br e crie sua conta com e-mail ou com a sua conta Google.

Acesso à API

A API está disponível nos planos Equipe e Enterprise. Veja os detalhes em Planos e preços.

2. Gere sua chave de API

Para fazer requisições à API, você precisa de uma chave:

1. No painel do TapSign, abra Integrações
2. Na aba API Keys, clique em Nova API Key
3. Dê um nome à chave e copie o valor exibido (começa com tsk_)

Importante

Não compartilhe sua chave com pessoas de fora da sua organização! A chave só é exibida uma vez, no momento da criação. Guarde em local seguro.

Testando sua chave

Envie a chave no header Authorization de todas as requisições:

curl -X GET "https://api.tapsign.com.br/v1/envelopes?size=1" \
  -H "Authorization: Bearer {token}"

Uma resposta 200 com a lista de envelopes confirma que a chave funciona. 401 indica chave incorreta ou desativada.

Token dinâmico

Você também pode usar tokens JWT obtidos com e-mail e senha. Veja Autenticação.

3. Envie seu primeiro documento

Via plataforma

No painel, crie um novo documento, faça upload do arquivo, adicione os signatários e envie para assinatura.

Via API

O envio acontece em quatro chamadas: enviar o arquivo, criar o envelope, adicionar os signatários e enviar.

# 1. Envie o arquivo (a resposta traz o "id" do documento)
curl -X POST https://api.tapsign.com.br/v1/documents \
  -H "Authorization: Bearer {token}" \
  -F "[email protected]" \
  -F "title=Contrato de Prestação de Serviços"

# 2. Crie o envelope com o documento (a resposta traz o "id" do envelope)
curl -X POST https://api.tapsign.com.br/v1/envelopes \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "documentId": 981,
    "title": "Contrato de Prestação de Serviços",
    "signOrder": "PARALLEL"
  }'

# 3. Adicione o signatário
curl -X POST https://api.tapsign.com.br/v1/envelopes/1234/signers \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Silva",
    "email": "[email protected]",
    "role": "SIGNER"
  }'

# 4. Envie para assinatura
curl -X POST https://api.tapsign.com.br/v1/envelopes/1234/send \
  -H "Authorization: Bearer {token}"

Detalhes de cada etapa: Criar Documento, Adicionar Signatário e Enviar para Assinatura.

Tem um modelo pronto?

Se o documento sai de um modelo cadastrado no TapSign, uma única chamada gera o documento, cria o envelope e envia para o signatário: veja Criar via Modelo.

4. Acompanhe o status

O envelope passa pelos seguintes status:

Status	Descrição
DRAFT	Rascunho: envelope criado, mas não enviado
SENT	Enviado: os signatários foram notificados
IN_PROGRESS	Em andamento: algum signatário já abriu ou assinou o documento
COMPLETED	Concluído: todos os signatários assinaram
EXPIRED	Expirado: o prazo para assinatura venceu
CANCELED	Cancelado: o remetente cancelou o envelope

A recusa de um signatário não muda o status do envelope: o signatário fica com status DECLINED e você recebe o webhook doc_refused.

Webhooks

Em vez de consultar o status periodicamente, configure webhooks para receber notificações automáticas quando os eventos acontecerem.

5. Próximos passos

Seção	Descrição
Ambiente de Testes	Teste sua integração sem afetar dados reais
Autenticação	Chave de API e JWT
Documentos	Crie documentos via API
Modelos	Modelos reutilizáveis com variáveis
Webhooks	Notificações em tempo real
Organizações	Gerencie equipes e permissões
Central de Ajuda	Guia sem código sobre API e webhooks