Ambiente de Testes (Sandbox)
O TapSign oferece um ambiente de sandbox completo para que voce possa testar sua integracao sem afetar dados reais ou gerar custos.
URLs do Sandbox
| Recurso | URL |
|---|---|
| API Sandbox | https://sandbox.api.tapsign.com.br |
| App Sandbox | https://sandbox.app.tapsign.com.br |
Documentos criados no ambiente sandbox nao possuem validade juridica. Utilize este ambiente exclusivamente para desenvolvimento e testes. Nunca envie documentos reais para assinatura no sandbox.
Diferenciando ambientes
As API Keys possuem prefixos distintos para cada ambiente, facilitando a identificacao:
| Ambiente | Prefixo da chave | Exemplo |
|---|---|---|
| Sandbox | tsk_test_* | tsk_test_abc123def456 |
| Producao | tsk_live_* | tsk_live_xyz789ghi012 |
# Requisicao no Sandbox
curl -X GET https://sandbox.api.tapsign.com.br/v1/envelopes \
-H "Authorization: Bearer tsk_test_abc123def456"
# Requisicao em Producao
curl -X GET https://api.tapsign.com.br/v1/envelopes \
-H "Authorization: Bearer tsk_live_xyz789ghi012"
Chaves de sandbox (tsk_test_*) nao funcionam no ambiente de producao, e vice-versa. Certifique-se de usar a chave correta para cada ambiente.
Criando uma conta no Sandbox
Para comecar a testar sua integracao:
- Acesse sandbox.app.tapsign.com.br
- Clique em Criar Conta
- Preencha seus dados (use qualquer email valido)
- Confirme seu email clicando no link recebido
- Acesse Configuracoes > API no painel
- Clique em Gerar Nova Chave para obter sua chave de teste
Ao criar sua conta no sandbox, o sistema gera automaticamente alguns documentos e envelopes de exemplo para que voce possa comecar a explorar a API imediatamente.
O que funciona no Sandbox
O ambiente sandbox replica toda a funcionalidade da producao:
| Funcionalidade | Disponivel no Sandbox |
|---|---|
| Criar envelopes | Sim |
| Upload de documentos | Sim |
| Enviar para assinatura | Sim |
| Assinar documentos | Sim |
| Webhooks | Sim |
| Templates | Sim |
| Paginacao e filtros | Sim |
| Rate limiting | Sim (mesmos limites) |
Diferencas em relacao a producao
- Documentos nao tem validade juridica
- Emails de notificacao incluem o banner [SANDBOX] no assunto
- Certificados de assinatura incluem marca d'agua de teste
- Nao ha cobranca por documentos enviados
Boas praticas
1. Teste no sandbox primeiro
Sempre desenvolva e teste sua integracao no sandbox antes de migrar para producao. Isso evita erros com documentos reais e custos desnecessarios.
2. Use variaveis de ambiente
Configure sua aplicacao para alternar entre sandbox e producao usando variaveis de ambiente:
# .env.development
TAPSIGN_API_URL=https://sandbox.api.tapsign.com.br
TAPSIGN_API_KEY=tsk_test_abc123def456
# .env.production
TAPSIGN_API_URL=https://api.tapsign.com.br
TAPSIGN_API_KEY=tsk_live_xyz789ghi012
3. Teste webhooks no sandbox
Configure seus webhooks no sandbox para validar que sua aplicacao processa corretamente todos os eventos antes de ativar em producao.
curl -X POST https://sandbox.api.tapsign.com.br/v1/webhooks \
-H "Authorization: Bearer tsk_test_abc123def456" \
-H "Content-Type: application/json" \
-d '{
"url": "https://seu-servidor.com/webhooks/tapsign",
"events": ["envelope.signed", "envelope.completed", "envelope.canceled"]
}'
4. Valide o fluxo completo
Antes de ir para producao, valide o ciclo completo:
- Criar envelope com documento
- Adicionar signatarios
- Enviar para assinatura
- Receber webhook de assinatura
- Baixar documento assinado
Antes de migrar para producao, confirme que:
- Todos os endpoints que voce usa estao funcionando no sandbox
- Webhooks estao sendo recebidos e processados corretamente
- Tratamento de erros esta implementado (400, 401, 429, 500)
- Retry com backoff exponencial esta configurado
- Variaveis de ambiente estao separadas por ambiente
- API Key de producao esta armazenada de forma segura
Proxima secao: Autenticacao -- Configure a autenticacao da sua integracao.