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

    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-03 16:33:50
    Página anterior
    Webhooks
    Próxima página
    Testar a API no Postman
    Built with