SuperSign - API Oficial
    • Introdução
    • Primeiro envelope em 5 minutos
    • Idempotência e erros
    • Estados do envelope
    • Webhooks
    • Limites de requisição
    • Testar a API no Postman
    • SuperSign API Pública
      • Raiz
        • Conta
          • Identificar a integração
          • Consultar a conta da integração
          • Consultar capacidades efetivas da integração
          • Consultar o catálogo público de capacidades
        • Envelopes
          • Criar rascunho de envelope
          • Listar envelopes
          • Excluir rascunho de envelope
          • Consultar envelope
          • Atualizar configurações do envelope
          • Enviar envelope
          • Listar histórico do envelope
          • Mover envelope para uma pasta
          • Cancelar envelope
        • Participantes
          • Sincronizar participantes do envelope
          • Listar participantes do envelope
          • Enviar lembrete ao participante
        • Documentos
          • Adicionar documentos ao envelope
          • Listar documentos do envelope
          • Substituir campos do documento
          • Listar campos do documento
          • Get document download url
        • Pastas
          • Criar pasta
          • Listar conteúdo da pasta
          • Consultar controle de acesso da pasta
          • Excluir pasta
          • Renomear pasta
          • Mover pasta
        • Webhooks
          • Criar webhook
          • Listar webhooks
          • Atualizar webhook
          • Excluir webhook
        • Contatos
          • Criar contato
          • Listar contatos
          • Consultar contato
          • Atualizar contato
          • Excluir contato
        • Equipe
          • Listar membros
        • Convites
          • Listar convites

    Testar a API no Postman

    O Postman pode importar o contrato oficial diretamente da SuperSign. Assim, sua coleção acompanha os endpoints e schemas publicados sem depender de uma cópia manual.

    Importar#

    1.
    No Postman, selecione Import.
    2.
    Escolha Link.
    3.
    Informe https://api.sandbox.supersign.com.br/openapi.json.
    4.
    Confirme a criação da coleção.
    5.
    Crie a variável de coleção baseUrl com o valor https://api.sandbox.supersign.com.br.
    6.
    Configure a autenticação Bearer da coleção com uma variável secreta apiKey contendo sua chave ss_test_....
    Não salve a chave como valor inicial, não sincronize o valor atual com um workspace público e não exporte a coleção com credenciais.

    Homologar no Sandbox#

    Comece por GET /v4/api/me. A resposta deve indicar environment: sandbox. Depois, execute o fluxo descrito em Primeiro envelope em 5 minutos.
    As operações POST exigem Idempotency-Key. Use uma variável dinâmica ou um identificador estável da operação de negócio. Durante novas tentativas da mesma operação, preserve o mesmo valor.

    Passar para Produção#

    Após homologar:
    altere baseUrl para https://api.sign.supersign.com.br;
    substitua a credencial por uma chave ss_live_...;
    mantenha as rotas, os corpos e o tratamento das respostas sem alteração.
    Uma chave de Sandbox nunca deve ser aceita em Produção, e uma chave de Produção nunca deve ser aceita no Sandbox.
    Modificado em 2026-09-06 19:21:48
    Página anterior
    Limites de requisição
    Próxima página
    Identificar a integração
    Built with