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

Limites de requisição

A API aplica limites em duas camadas: uma proteção por origem antes da autenticação e um limite contratual por conta depois que a API Key é validada.

Limites atuais#

CamadaLimiteEscopo
Proteção de origem1.200 requisições por minutoPor IP; endereços IPv6 são agrupados por /64
Conta padrão30 requisições por minutoCompartilhado por todas as API Keys e todos os IPs da conta
Conta com limite contratadoValor configurado no plano ou override da contaCompartilhado por todas as API Keys e todos os IPs da conta
O limite por conta usa uma janela fixa de 60 segundos. Criar outra API Key não aumenta a franquia.
O valor contratual pode ser superior ao padrão. Confirme o limite da sua conta durante a habilitação comercial da API.

Headers#

Em respostas autenticadas, os headers representam o limite efetivo da conta:
HeaderSignificado
X-RateLimit-LimitTotal de requisições permitido na janela atual
X-RateLimit-RemainingRequisições ainda disponíveis; nunca fica negativo
X-RateLimit-ResetSegundos até a virada da janela
Retry-AfterSegundos que devem ser aguardados; aparece no 429
Exemplo de limite esgotado:
{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "This account exceeded 30 API requests per minute."
  }
}
X-RateLimit-Reset e Retry-After usam segundos, não timestamp Unix. Quando a credencial ainda não foi autenticada, uma resposta de bloqueio pode trazer os headers da proteção por origem, pois a conta ainda não é conhecida.

Estratégia recomendada#

1.
Respeite Retry-After quando ele existir.
2.
Caso não exista, use backoff exponencial com jitter.
3.
Mantenha a mesma Idempotency-Key ao repetir uma operação.
4.
Limite a concorrência no seu lado.
5.
Use webhooks em vez de consultar repetidamente o estado do envelope.
Exemplo em JavaScript:

Falha do contador#

Se o serviço responsável pela contagem estiver indisponível, a API responde 503 em vez de continuar sem proteção. Repita com backoff e, em operações POST, preserve a mesma Idempotency-Key.

O que não deve ser feito#

Não crie várias chaves para tentar multiplicar o limite.
Não faça polling em intervalos curtos.
Não troque a chave de idempotência ao receber 429, timeout ou 503.
Não use o texto de message como regra de negócio; use status HTTP e error.code.
Não distribua tráfego entre IPs para contornar a proteção.
Modificado em 2026-09-08 22:04:56
Página anterior
Webhooks
Próxima página
Criar um envelope a partir de um modelo
Built with