SuperSign - API Oficial
  1. Introdução
  • SuperSign API Pública
    • Introdução
      • Primeiro envelope em 5 minutos
      • Integrar com IA
      • Testar a API no Postman
      • Paginação e filtros
      • Catálogo de erros
      • Receitas em Node.js, PHP e Python
      • Changelog
      • Idempotência e erros
      • Estados do envelope
      • Webhooks
      • Limites de requisição
      • Criar um envelope a partir de um modelo
      • Gerar um cliente (SDK)
      • Evento ENVELOPE_SENT
      • Evento SIGNATORY_SIGNED
      • Evento ENVELOPE_COMPLETED
      • Evento ENVELOPE_VOIDED
      • Evento ENVELOPE_EXPIRED
      • Segurança e verificação
      • Entregas, retentativas e reenvio
      • Testar na Sandbox e automatizar
      • Introdução à documentação
      • Posicionar campos por texto âncora
      • Verificar um documento selado
      • Evento PARTICIPANT_DECLINED
      • Evento EMAIL_BOUNCED
    • Referência da API
      • Conta
        • Consultar a conta da integração
        • Consultar capacidades da integração
        • Consultar o catálogo de capacidades
        • Listar chamadas da própria chave
        • Consultar consumo do ciclo
        • Validar a chave de API
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar e enviar envelope numa chamada
        • Gerar URL de download do envelope em ZIP
        • Duplicar envelope
        • Consultar envelope
        • Criar rascunho de envelope
        • Mover envelope para outra pasta
        • Anular envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
      • Participantes
        • Listar participantes do envelope
        • Aprovar participante aprovador
        • Recusar como participante aprovador
        • Corrigir contato do participante
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Confirmar o PDF convertido de um DOCX
        • Validar um documento selado
        • Reordenar documentos do envelope
        • Consultar o tamanho das páginas
        • Achar texto (âncora) no documento
        • Verificar um documento selado
        • Baixar o PDF de exemplo
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Atualizar contato parcialmente
        • Listar envelopes do contato
        • Listar listas de contatos
        • Consultar lista de contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar grupos da conta
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Listar todas as pastas
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Listar entregas de um webhook
        • Detalhar uma entrega de webhook
        • Reenviar uma entrega de webhook
        • Girar o segredo de assinatura do webhook
        • Enviar um evento de teste para o webhook
        • Listar webhooks
        • Criar webhook
        • Atualizar webhook
      • Modelos
        • Listar modelos
        • Consultar modelo
        • Criar envelope a partir de modelo
        • Criar modelo em rascunho
        • Editar título e descrição do modelo
        • Consultar processamento do documento do modelo
        • Ativar modelo
        • Duplicar modelo
        • Enviar documentos do modelo
        • Definir vagas do modelo
        • Posicionar campos no documento do modelo
        • Apagar modelo em rascunho
        • Reordenar documentos do modelo
        • Remover documento do modelo
        • Definir cópias do modelo
        • Achar texto (âncora) no documento do modelo
      • Auditoria e relatórios
        • Listar envelopes anulados
        • Relatório de envelopes
        • Relatório de uso por grupo
      • Etiquetas
        • Aplicar etiqueta ao envelope
        • Remover etiqueta do envelope
        • Listar etiquetas da conta
  1. Introdução

Testar a API no Postman

Postman#

O Postman pode importar o contrato oficial diretamente da SuperSign. Assim, a coleção acompanha os endpoints e schemas publicados sem manter 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 retries da mesma intençã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 rotas, corpos e tratamento de 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-08 22:04:56
Página anterior
Integrar com IA
Próxima página
Paginação e filtros
Built with