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
    • Referência da API
      • Conta
        • Consultar a conta da integração
        • Consultar capacidades da integração
        • Consultar o catálogo de capacidades
        • Validar a chave de API
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar rascunho de envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
        • Get Envelope
        • Move envelope to folder
        • Void envelope
      • Participantes
        • Listar participantes do envelope
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Criar webhook
        • List webhook endpoints
        • Edit webhook endpoint
  1. Introdução

Catálogo de erros

Decida pelo status HTTP e por error.code; error.message é destinado ao diagnóstico humano e pode evoluir.
CódigoHTTP esperadoComo tratar
INVALID_API_KEY401Confira ambiente, prefixo, revogação e header Authorization.
RESOURCE_NOT_FOUND404Confira o identificador e o vínculo do recurso com a conta.
RATE_LIMIT_EXCEEDED429Respeite Retry-After e repita com backoff e jitter.
IDEMPOTENCY_KEY_REQUIRED400Envie Idempotency-Key em toda operação POST.
IDEMPOTENCY_KEY_IN_USE409Aguarde e repita a mesma requisição com a mesma chave.
IDEMPOTENCY_KEY_REUSE422Não reutilize a chave com rota ou corpo diferente.
IDEMPOTENCY_UNAVAILABLE503Repita com backoff sem trocar a chave.
ENVELOPE_WRITE_NOT_ALLOWED403O envelope não permite essa alteração para o ator ou estado atual.
DOCUMENT_TOO_LARGE413Reduza o arquivo conforme o limite informado pela resposta.
VERSION_UNAVAILABLE403A versão solicitada do documento não está disponível para download.
CONTACT_ALREADY_EXISTS409Consulte ou atualize o contato existente.
FOLDER_SELF_MOVE400Não mova uma pasta para ela mesma.
FOLDER_CIRCULAR_MOVE400Escolha um destino fora da árvore descendente da pasta.
NON_EMPTY_FOLDER403Remova ou mova o conteúdo antes de excluir a pasta.
Falhas 5xx, 429, timeout e erros de rede podem ser transitórios. Em operações POST, preserve a mesma Idempotency-Key durante toda a tentativa lógica.
Modificado em 2026-09-08 22:04:56
Página anterior
Paginação e filtros
Próxima página
Receitas em Node.js, PHP e Python
Built with