Skip to main content

Modo de Teste

Usar o Modo Teste

O Modo Teste (também chamado de Sandbox para Desenvolvedores) permite que você explore e teste diferentes formas de usar e integrar o Sign sem a necessidade de operar no ambiente de produção. Você pode usar o Modo Teste para depurar e testar sua solução de integração. Além disso, você pode disponibilizar seus templates de produção para testes no ambiente de teste. Todas as ações realizadas no Modo Teste não impactam o ambiente de produção, pois os dois são completamente isolados.

API e Incorporação no Modo Teste são gratuitos e estão disponíveis tanto na nuvem quanto on-premises.

Notas

  • O ambiente de teste funciona como uma conta Sign completamente separada e isolada.
  • As chaves API criadas no ambiente de teste não podem ser usadas no ambiente de produção, e vice-versa.
  • O Modo Teste é destinado para depuração e testes de integração, não para uso em produção.
  • Templates criados no ambiente de produção podem ser compartilhados com o ambiente de teste para testes e ajustes sem necessidade de recriá-los.

Como ativar o Modo Teste

  1. Faça login na sua conta Sign.
  2. Clique nas suas iniciais no canto superior direito da tela e selecione Modo Teste no menu suspenso. Alternar Modo Teste na barra de navegação
  3. Você será redirecionado instantaneamente para o ambiente de teste, que é completamente isolado do seu ambiente de produção.
  4. No mesmo menu, você pode selecionar Perfil para ver seus dados no ambiente de teste. Esses dados terão pequenas diferenças em relação ao ambiente de produção. Por exemplo:
    • Seu e-mail terá o sufixo +test.
    • O nome da empresa começará com Testing. Essas diferenças facilitam a distinção entre os ambientes de teste e produção. E-mail do Perfil no Modo Teste

Como desativar o Modo Teste

  • Enquanto o Modo Teste estiver ativo, você verá um badge Modo Teste no canto superior direito da tela. Clique nesse badge para voltar imediatamente ao ambiente de produção.
  • Alternativamente, você pode ir ao menu Perfil e desativar o Modo Teste no menu à esquerda.

Como compartilhar um template de produção com o ambiente de Teste

Embora os ambientes sejam completamente isolados, você pode disponibilizar um template de produção no ambiente de teste para fins de depuração.

Nota: As alterações feitas em um template no ambiente de teste serão refletidas na versão de produção do template. Isso permite depurar templates no ambiente de teste sem a necessidade de recriá-los na produção.

  1. No ambiente de produção, abra o template que deseja compartilhar com o ambiente de teste.
  2. Clique no botão no canto superior direito da tela.
  3. No modal que abrir, vá para a aba API e Incorporação.
  4. Na parte inferior do modal, ative a opção Compartilhar template com o Modo Teste. Compartilhar template com Modo Teste
  5. Pronto! Seu template agora está disponível para testes e depuração no ambiente de teste.

Como usar a API no ambiente de Teste

  1. Obtenha uma chave API para o ambiente de teste:
    • Clique nas suas iniciais no canto superior direito da tela e selecione Console.
    • No menu à esquerda, selecione API.
    • Ative o Modo Teste no canto superior direito.
    • Copie sua chave API clicando no botão Copiar. Chave API do Modo Teste
  2. Use essa chave API para integrar com o ambiente de teste. O Sign oferece SDKs para várias linguagens:

Nota: Esta chave API é para uso apenas no ambiente de teste. Ela não pode acessar dados do ambiente de produção e deve ser substituída pela chave API de produção quando sua integração estiver pronta.

Como usar a incorporação no ambiente de Teste

Vamos ver como integrar o Form Builder no seu site usando uma chave API de teste.

  1. Gere um token JWT no backend do seu site.
  2. Dependendo da linguagem do backend, utilize a biblioteca apropriada para gerar o token:
  3. Inclua os seguintes atributos ao gerar o token JWT:
    • user_email - Email do usuário administrador (obrigatório). Para o ambiente de teste, terá o sufixo +test e pode ser encontrado no seu perfil.
    • integration_email - Email do usuário para quem o template está sendo criado (opcional).
    • document_urls - Um array de URLs dos documentos que você deseja exibir no builder (opcional).
  4. Envie o token JWT para o builder no seu frontend. Implemente isso conforme sua necessidade frontend.
  5. Pronto! Agora você pode usar o builder no seu site para testar e depurar sua integração.

Notas

  • Não use o e-mail do administrador de produção para o campo user_email no ambiente de teste.
  • Quando tudo estiver funcionando corretamente, substitua o user_email pelo email do administrador de produção e a chave API de teste pela chave API de produção.
  • As URLs dos documentos devem estar acessíveis publicamente, sem autenticação ou restrições.
  • Você pode customizar o builder ainda mais usando atributos adicionais. A lista completa está disponível aqui.
Back to top