Informacoes Gerais

Bem-vindo a documentacao da API do TapSign. Aqui voce encontra tudo o que precisa para integrar assinaturas digitais ao seu sistema de forma rapida e segura.

Visao Geral

A API do TapSign e uma API REST que utiliza o formato JSON para envio e recebimento de dados. Todas as comunicacoes sao feitas exclusivamente via HTTPS -- requisicoes HTTP simples serao rejeitadas com erro.

Base URL

https://api.tapsign.com.br/v1

Autenticacao

Todas as requisicoes autenticadas devem incluir o header:

Authorization: Bearer {token}

Onde {token} pode ser uma API Key (formato tsk_live_* ou tsk_test_*) ou um JWT obtido via endpoint de autenticacao.

Consulte o guia de autenticacao para detalhes completos.

Convencoes da API

Content-Type

Todas as requisicoes com corpo devem usar Content-Type: application/json, exceto uploads de arquivo que usam multipart/form-data.

Strings nulas

Campos de texto que nao possuem valor sao retornados como null, nunca como string vazia "".

{
  "name": "Contrato de Prestacao de Servicos",
  "description": null
}

Atencao

Ao consumir a API, certifique-se de que seu parser trata null corretamente. Comparar com string vazia pode causar comportamentos inesperados.

Booleanos

Valores booleanos sao retornados como true ou false nativos do JSON, nunca como strings "true" ou "false".

{
  "signed": true,
  "canceled": false
}

Gerenciamento de horarios

Todos os horarios retornados pela API estao em UTC+0 (Tempo Universal Coordenado), no formato ISO 8601.

{
  "created_at": "2026-03-29T14:30:00Z",
  "signed_at": "2026-03-29T18:45:22Z"
}

Fuso horario do Brasil

Para converter para o horario de Brasilia (UTC-03:00), subtraia 3 horas do horario retornado. Exemplo: 14:30:00Z corresponde a 11:30:00 no horario de Brasilia.

Se sua aplicacao exibe datas para usuarios no Brasil, faca a conversao no lado do cliente para garantir que os horarios estejam corretos.

IDs

Todos os recursos possuem um identificador unico no formato UUID v4:

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Paginacao

Endpoints de listagem suportam paginacao via query parameters:

GET /v1/envelopes?page=1&size=20

A resposta inclui metadados de paginacao:

{
  "data": [],
  "pagination": {
    "page": 1,
    "size": 20,
    "total": 150,
    "totalPages": 8
  }
}

Links rapidos

Topico	Descricao
Autenticacao	Configure API Keys e tokens JWT
Ambiente de Testes	Use o sandbox para testar sem riscos
Documentos	Crie e gerencie documentos via API
Webhooks	Receba notificacoes em tempo real
Rate Limit	Limites de requisicoes por plano
Status de Erros	Codigos de erro e como trata-los

Suporte

Precisa de ajuda com a integracao? Nossa equipe esta disponivel para auxiliar:

Canal	Contato
Email	suporte@tapsign.com.br
WhatsApp	Fale conosco

Dica

Antes de entrar em contato, verifique se sua duvida ja esta respondida na secao de FAQ. Para problemas tecnicos, inclua o request_id retornado no header da resposta -- isso nos ajuda a investigar mais rapidamente.

---

Proxima secao: Ambiente de Testes -- Configure o sandbox para testar sua integracao.