Como configurar o interceptor de Rate Limit?

Esse interceptor só pode ser inserido no fluxo de requisição. A seção Flows pode ser configurada ao criar ou editar uma API ou Plano:

1. Na API:

  1. Acesse API Design > API Catalog e encontre a sua API;

  2. Na seção Flows, clique em Edit;

  3. Clique e arraste o interceptor Rate Limit para o flow. Ao fazer isso, uma janela com as propriedades de configuração abrirá.

  4. Escolha o tipo de configuração entre Total Calls, IP e Header;

    • Ao escolher Total Calls, você limita as requisições pelo número de chamadas, independente da origem.

    • Ao escolher IP, você limita as requisições por IP. Isso quer dizer que cada IP poderá acessar pelo número de vezes que você configurou.

    • Ao escolher Header você configura um header específico para a restrição de tráfego. Ao selecionar essa opção, você deve informar:

      • Key: a chave do header desejado.

      • Missing header behavior: configura o comportamento para requisições sem o header. Escolha entre:

        • Allow: ignora o processamento do interceptor, permitindo o fluxo da requisição.

        • Total Calls: trata a requisição com base no número total de chamadas.

        • Abort: bloqueia a requisição.

  5. Informe o número máximo de chamadas no campo Calls;

  6. Em Interval, selecione o período de limite das chamadas entre Second, Minute, Hour, Day ou Month;

  7. Se quiser adicionar um percentual de chamadas acima do limite permitido, marque a opção Soft Limit e informe o valor do campo %;

  8. Se quiser adicionar um parâmetro para receber a quantidade de requisições restantes no header da resposta, marque a opção Return quota header;

  9. Clique Save.

Se preferir, siga os passos acompanhando o vídeo:

2. No Plano

  1. Acesse API Design > Plans e encontre o seu plano;

  2. Clique em Edit;

  3. Na seção Flows, clique e arraste o interceptor Rate Limit para o flow. Ao fazer isso, uma janela com as propriedades de configuração abrirá.

  4. Escolha o tipo de configuração entre Total Calls, IP e Header;

    • Ao escolher Total Calls, você limita as requisições pelo número de chamadas, independente da origem.

    • Ao escolher IP, você limita as requisições por IP. Isso quer dizer que cada IP poderá acessar pelo número de vezes que você configurou.

    • Ao escolher Header você configura um header específico para a restrição de tráfego. Ao selecionar essa opção, você deve informar:

      • Key: a chave do header desejado.

      • Missing header behavior: configura o comportamento para requisições sem o header. Escolha entre:

        • Allow: ignora o processamento do interceptor, permitindo o fluxo da requisição.

        • Total Calls: trata a requisição com base no número total de chamadas.

        • Abort: bloqueia a requisição.

  5. Informe o número máximo de chamadas no campo Calls;

  6. Em Interval, selecione o período de limite das chamadas entre Second, Minute, Hour, Day ou Month;

  7. Se quiser adicionar um percentual de chamadas acima do limite permitido, marque a opção Soft Limit e informe o valor do campo %;

  8. Se quiser adicionar um parâmetro para receber a quantidade de requisições restantes no header da resposta, marque a opção Return quota header;

  9. Clique Save.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]