Caixa de areia
Uma chamada API provisiona um locatário de sandbox isolado, cria uma chave API e propaga um assinante de demonstração — sem fila de acesso antecipado, sem configuração manual.
O que é enviado quando você reivindica um sandbox
O fluxo de sandbox é um modo no endpoint de registro de autoatendimento padrão. Tudo o que você obtém é um inquilino real na plataforma real - apenas marcado como `isSandbox: true` e pré-semeado para que seu primeiro `curl` seja bem-sucedido.
Inquilino isolado Chave
A new tenant with your chosen name, marked `isSandbox: true`. Sandbox API keys never work against another tenant, and no other tenant''s keys work against yours.
API retornada uma vez
A resposta de registro inclui a chave `esk_test_…` completa. Ele é mostrado uma vez - armazene-o no gerenciador de segredos do servidor ou crie outro em Admin → Desenvolvedor → API Chaves.
Assinante de demonstração propagado
Um registro de cliente (`sandbox-signer-{yourTenantId}`) é pré-criado. Quando a propagação for bem-sucedida, `sampleTemplateId` será incluído para que a primeira chamada do servidor possa ser criada a partir do modelo.
Plano gratuito, sem configuração de faturamento
Os locatários do sandbox estão bloqueados no lado do servidor do plano gratuito. O registro nunca atinge o pipeline de cobrança e um `planId` no corpo da solicitação é ignorado quando `mode: sandbox` é definido.
Webhooks + console do desenvolvedor
Registre endpoints em Admin → Desenvolvedor → Webhooks enquanto estiver conectado. Reproduza entregas com falha e inspecione solicitações API em Admin → Desenvolvedor → Console.
Expiração informativa de 30 dias
O inquilino carrega uma dica `expiresAt` (atualmente informativa – a aplicação é um acompanhamento). Nada é excluído automaticamente hoje; o campo está lá para o futuro trabalho de limpeza.
Reivindicar um sandbox em uma solicitação
Pré-requisitos: um endereço de e-mail válido e uma senha com mais de 8 caracteres. Saída esperada: HTTP 201 com seu `tenantId`, `sandbox.apiKey` (mostrado uma vez) e o `demoCustomerId` propagado.
curl -sS -X POST https://api.endorsedsign.com/api/auth/register \
-H 'Content-Type: application/json' \
-d '{
"tenantName": "Acme Dev Sandbox",
"adminEmail": "you@acme.example",
"password": "your-strong-password",
"mode": "sandbox"
}' | jq '.data | { tenantId, sandbox }'
# {
# "tenantId": "acme-dev-sandbox",
# "sandbox": {
# "apiKey": "esk_test_…", # capture this now — shown once
# "keyPrefix": "esk_test_…",
# "keyId": "…",
# "scopes": ["documents:write", …],
# "demoCustomerId": "sandbox-signer-acme-dev-sandbox",
# "demoCustomerName": "Sandbox Signer",
# "expiresAt": "2026-…"
# }
# }Verifique seu e-mail de administrador na sua caixa de entrada antes de entrar no Admin. A chave API funciona imediatamente – a verificação apenas bloqueia o console humano.
Da sandbox à produção
- 1
Reivindicar sua caixa de areia
POST /api/auth/register with `mode: sandbox`. Capture the returned API key in your secret store.
- 2
Ligue para API com a chave sandbox
Confirme GET /api/v1/zapier/auth/test, crie a partir do modelo e envie para assinatura. Registre webhooks em Admin → Desenvolvedor → Webhooks e assista as entregas no console.
- 3
Revise a lista de verificação de integração
Confirme verificação de assinatura webhook, registro de identificação de correlação e idempotência. Lista de verificação completa no console do desenvolvedor em Admin → Desenvolvedor.
- 4
Inscreva-se para produção
Quando estiver pronto, registre um locatário de produção separado por meio do mesmo endpoint com `mode: production` (ou a UI de inscrição padrão). Seu locatário do sandbox permanece onde você pode continuar testando.
Perguntas comuns
Reivindicar seu sandbox em uma chamada
O endpoint está ativo hoje. O corpo da resposta inclui uma chave `esk_test_` que você pode confirmar no seu servidor.