Skip to main content
A API da Salvy oferece dois ambientes: sandbox e produção. Você não precisa trocar a URL da API para alternar entre eles. O ambiente é definido pela chave de API utilizada.
  • Produção: executa ações reais, como envio de SMS, e-mails, notificações e cobranças.
  • Sandbox: ambiente isolado para desenvolvimento e testes. Nenhuma ação externa real (SMS, e-mail, notificações e outras) é executada.
Você pode usar a mesma URL em desenvolvimento e produção. Para trocar de ambiente, basta trocar a chave de API.

​
Como o ambiente é escolhido

Você não muda o endereço nem envia nenhum parâmetro especial. Basta usar a chave do ambiente desejado no cabeçalho Authorization. Você identifica o ambiente e o tipo da chave pelo prefixo:
Chaves de API de empresa anteriores a 07/2026 não têm prefixo.
Chaves de organização são emitidas apenas em produção por enquanto (prefixo salvy_org_prod_). O suporte a sandbox para chaves de organização será adicionado quando disponível.
Produção
Sandbox

​
Primeiros passos no sandbox

Para começar a testar, crie uma chave de sandbox. O passo a passo está no guia de Chaves de API. Quando você cria a primeira chave de sandbox, a Salvy cria automaticamente um ambiente de testes para a sua empresa. Esse ambiente copia apenas o perfil da empresa (como razão social, CNPJ e endereço). Os dados operacionais começam vazios e as próximas chaves de sandbox utilizam esse mesmo ambiente.

​
O que é replicado

  • O perfil da sua empresa é copiado, para que o sandbox represente a sua organização.
  • Os dados (linhas, colaboradores, equipamentos) não são copiados: o sandbox começa vazio. Você cria os dados de teste via API, da mesma forma que faria em produção.
  • Tudo o que você cria no sandbox, como colaboradores, ativos, linhas e outros recursos, fica isolado de produção.

​
Comportamento no sandbox

Uma resposta 2xx significa que a Salvy processou a requisição com sucesso. No sandbox, isso não significa que uma ação real (como o envio de uma mensagem) foi executada para um destinatário real.
Nenhuma operação no sandbox gera cobrança. Tudo o que você cria no sandbox fica isolado de produção.

​
Linhas mobile-did no sandbox

No sandbox, a criação de uma linha mobile-did sempre retorna o mesmo número de demonstração, +5541963475701, para qualquer empresa. Nenhum número real é reservado.
  • Apenas o DDD 41 é aceito. Outro DDD retorna 409 com o código did-area-code-out-of-stock.
  • A listagem de DDDs com productType=mobile-did retorna apenas o DDD 41.

​
Termos de equipamentos no sandbox

No sandbox, o envio de um termo não manda e-mail para o colaborador e não gera um documento real para assinatura. O termo é criado com status pending-signature, como em produção. Para testar o fluxo de assinatura:
  1. Envie o termo com Enviar termo e guarde o id retornado.
  2. Simule a assinatura com Simular assinatura do termo. O termo passa para signed, o PDF assinado fica disponível em Baixar termo assinado e o webhook Termo assinado é disparado.
A simulação só está disponível com chaves de sandbox e para termos enviados no sandbox. Um termo cancelado não pode ter a assinatura simulada.

​
Boas práticas e segurança

Não misture as chaves. Como o endereço é o mesmo nos dois ambientes, usar uma chave de produção em um teste executa ações reais, incluindo envios e cobranças. Confirme sempre o prefixo da chave antes de usá-la.
  • Use chaves de sandbox (salvy_test_) em desenvolvimento e testes automatizados.
  • Guarde as chaves de produção e de sandbox separadamente e com nomes descritivos. Veja Chaves de API.
  • Valide toda a sua integração no sandbox antes de trocar para uma chave de produção.