Aplicar limites de monetização em proxies de API

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Nesta página, descrevemos como aplicar limites de monetização anexando políticas a proxies de API em um produto de API monetizado.

Adicionar uma política de autenticação

A monetização da Apigee usa a política VerifyAPIKey ou a operação VerifyAccessToken da política OAuth2 para determinar se uma solicitação de entrada é monetizável verificando o plano de taxas publicado ativo.

Anexe a política ao proxy de API usando a IU ou a API da Apigee. Consulte Editar um proxy de API para informações sobre como editar um proxy.

Consulte também:

Aplicar assinaturas de desenvolvedor em produtos de API

Anexe a política MonetizationLimitsCheck aos proxies de API para aplicar assinaturas de desenvolvedor no produto de API:

  • Se não houver um plano de taxa de monetização para o produto de API buscado durante a execução da chamada de proxy, o produto será considerado sem monetização, a política MonetizationLimitsCheck não coletará mais dados e não terá efeito.
  • Se um plano de taxa for encontrado, mas não houver uma assinatura para o desenvolvedor de API, a política MonetizationLimitsCheck vai gerar uma falha e bloquear a chamada de API.

Quando você anexa a política MonetizationLimitsCheck a um proxy de API, as variáveis de fluxo mint.limitscheck.* e mint.subscription_* são preenchidas, conforme descrito em Como depurar a política MonetizationLimitsCheck e na referência da variável de fluxo mint.

Veja mais informações em:

Aplicar cotas de monetização em proxies de API

Uma cota define o número de solicitações permitidas para um produto de API em um determinado período Para aplicar cotas de monetização, é recomendável definir o valor da cota ao criar um produto de API.

Definir um valor de cota para um produto de API não aplica automaticamente as restrições ao número de chamadas que podem ser feitas pelo produto de API. Também é preciso adicionar políticas de cota aos proxies de API que são referenciados pelo produto de API para garantir que o valor da cota definido no nível do produto de API seja aplicado.

Edite a política de cota para ativar o elemento <UseQuotaConfigInAPIProduct> e usar a configuração de cota definida no nível do produto de API.

Exemplo:

<Quota continueOnError="false" enabled="true" name="impose-quota">
    <DisplayName>Impose Quota</DisplayName>
    <UseQuotaConfigInAPIProduct stepName="verify-api-key">
        <DefaultConfig>
            <Allow>10000</Allow>
            <Interval>1</Interval>
            <TimeUnit>week</TimeUnit>
        </DefaultConfig>
    </UseQuotaConfigInAPIProduct>
    <Distributed>true</Distributed>
    <Synchronous>true</Synchronous>
    <StartTime>2021-01-01 12:00:00</StartTime>
</Quota>

Ao anexar a política de cotas a um proxy de API, as variáveis de fluxo ratelimit.* são preenchidas, conforme descrito em Como depurar a política de cotas e na referência de variáveis de fluxo da política de cotas.

Veja mais informações em: