Autenticacao

O TapSign oferece dois metodos de autenticacao para acesso a API: API Key (token estatico) e JWT (token dinamico). Escolha o metodo mais adequado para sua integracao.

API Key (Token Estatico)

A forma mais simples de autenticar. Ideal para integracoes server-to-server.

Gerando uma API Key

1. Acesse Configuracoes > API no painel do TapSign
2. Clique em Gerar Nova Chave
3. Copie a chave gerada (formato tsk_live_*)
4. Armazene a chave de forma segura

Importante

A chave de API so e exibida uma vez no momento da criacao. Armazene-a em local seguro (variavel de ambiente, cofre de segredos). Nunca exponha a chave em codigo-fonte ou repositorios publicos.

Usando a API Key

Envie a chave no header Authorization de cada requisicao:

curl -X GET https://api.tapsign.com.br/v1/envelopes \
  -H "Authorization: Bearer tsk_live_abc123def456"

Gerenciamento de chaves

Metodo	Endpoint	Descricao
POST	/v1/api-keys	Criar nova chave
GET	/v1/api-keys	Listar chaves ativas
DELETE	/v1/api-keys/{id}	Excluir chave
PATCH	/v1/api-keys/{id}/deactivate	Desativar chave

Permissoes

Cada API Key herda as permissoes do usuario que a criou. Voce pode criar multiplas chaves com escopos diferentes.

---

JWT (Token Dinamico) — Recomendado

Para integracoes que necessitam de tokens com tempo de vida limitado. Garante seguranca adicional, ideal para aplicacoes que acessam a API em nome de usuarios.

Obter token de acesso

Faca uma requisicao POST para o endpoint de autenticacao:

curl -X POST https://api.tapsign.com.br/v1/auth/api/token \
  -H "Content-Type: application/json" \
  -d '{
    "email": "seu@email.com",
    "password": "sua_senha"
  }'

Resposta (200 OK):

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 3600,
  "tokenType": "Bearer"
}

Usando o token JWT

curl -X GET https://api.tapsign.com.br/v1/envelopes \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Atualizar token de acesso

Quando o accessToken expirar, use o refreshToken para obter um novo:

curl -X POST https://api.tapsign.com.br/v1/auth/api/token-refresh \
  -H "Content-Type: application/json" \
  -d '{
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }'

Resposta (200 OK):

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 3600,
  "tokenType": "Bearer"
}

Validade dos tokens

Token	Validade
Access Token	1 hora
Refresh Token	30 dias

Atencao

Quando o refresh token expirar, o usuario precisa autenticar novamente com email e senha.

---

Boas praticas de seguranca

1. Nunca exponha credenciais no frontend — Use variaveis de ambiente no servidor
2. Rotacione API Keys periodicamente — Crie novas chaves e desative as antigas
3. Use HTTPS sempre — Todas as requisicoes devem usar HTTPS
4. Limite os escopos — Crie chaves com apenas as permissoes necessarias
5. Monitore o uso — Acompanhe os logs de acesso da API
6. Use JWT para apps client-side — Tokens com validade limitada sao mais seguros

Ambientes

Ambiente	Base URL	Prefixo da chave
Producao	https://api.tapsign.com.br	tsk_live_*
Sandbox	https://sandbox.api.tapsign.com.br	tsk_test_*

Sandbox

Use o ambiente sandbox para testar sua integracao sem afetar dados reais. Os documentos enviados no sandbox nao tem validade juridica. Veja mais em Ambiente de Testes.