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

Changelog

Changelog da API pública#

Este histórico registra mudanças do contrato /v4/api/*. Correção interna que não altera o contrato não gera uma nova entrada.

2026-09-07#

Nova operação: POST /v4/api/envelopes/{envelopeId}/documents/{documentId}/confirm-conversion. Ela fecha o envio de .docx pela API pública: quem manda um .docx em POST .../documents recebe a prévia convertida em PDF e precisa confirmá-la antes de seguir. Sem esta operação o envelope ficava parado na conversão, sem caminho de saída pela API. São 39 operações publicadas.
As operações passaram a declarar as recusas, e não só o sucesso: 400, 403, 404, 409 e 413 agora fazem parte do OpenAPI, com exemplo de corpo. Antes, um gerador de client não criava o ramo de tratamento desses status e a recusa aparecia primeiro em produção.
A resposta de erro voltou a trazer details. O campo existe em 409 SIGNATURES_NEED_RESET (details.affectedSignatoryIds), em 400 FIELD_PAGE_OUT_OF_BOUNDS (details.documentId, page, pageCount) e em 413 DOCUMENT_TOO_LARGE.
403 por limite de plano na API pública passou a sair como 403. Antes, o serializer recusava o corpo e o cliente recebia 500 no lugar da recusa.
Os limites de tamanho de arquivo do plano da conta passaram a valer também em POST /v2/envelopes e POST /v3/envelopes, que antes aplicavam só o teto técnico. O contrato dessas rotas não mudou; o comportamento sim.
Sem mudança: 401 (chave ausente, inválida ou revogada) e 429 (teto de requisições da conta) já eram declarados antes desta data.

2026-09-06#

A referência passou a organizar as 38 operações em nove recursos.
Sandbox e Produção passaram a constar no contrato, com Sandbox em primeiro lugar.
Todas as operações passaram a declarar operationId, título e descrição públicos.
Headers de rate limit e a resposta 429 passaram a fazer parte do OpenAPI.
Foram adicionados guias de IA, Postman, paginação, erros e exemplos por linguagem.

Política#

Mudança compatível: pode ser publicada na v4 com registro neste changelog.
Mudança incompatível: exige nova versão ou período formal de migração.
A remoção de campo, status, evento ou comportamento publicado nunca deve acontecer silenciosamente.
Modificado em 2026-09-08 22:04:56
Página anterior
Receitas em Node.js, PHP e Python
Próxima página
Idempotência e erros
Built with