Aplique limites de rentabilização em proxies de API

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Esta página descreve como aplicar limites de rentabilização anexando políticas a proxies de API num produto de API rentabilizado.

Adicione uma política de autenticação

A rentabilização do Apigee usa a política VerifyAPIKey ou a operação VerifyAccessToken da política OAuth2 para determinar se um pedido recebido é rentabilizável, verificando o plano de tarifas publicado ativo.

Anexe a política ao proxy de API através da IU do Apigee ou da API. Consulte o artigo Editar um proxy de API para informações sobre a edição de um proxy.

Veja também:

Aplique subscrições a produtos de API

Anexe a política MonetizationLimitsCheck aos proxies de API para aplicar subscrições no produto de API por programador ou AppGroup:

  • Se não existir nenhum plano tarifário ativo para o produto API obtido durante a execução da chamada de proxy, o produto é considerado não rentabilizado, a política MonetizationLimitsCheck não obtém mais dados e a política não tem efeito.
  • Se for encontrado um plano tarifário, mas não for encontrada uma subscrição para o programador da API ou o AppGroup, a política MonetizationLimitsCheck gera uma falha e bloqueia a chamada à API.

Quando anexa a política MonetizationLimitsCheck a um proxy de API, o Apigee preenche as variáveis de fluxo mint.limitscheck.* e mint.subscription_*, conforme descrito em Depurar a política MonetizationLimitsCheck e na referência da variável de fluxo mint.

Para mais informações, consulte:

Aplique quotas de rentabilização em proxies de API

Uma quota define o número de pedidos permitidos para um produto API durante um determinado período. Para aplicar quotas para rentabilização, recomendamos que defina o valor da quota quando criar um produto API.

A definição de um valor de quota para um produto de API não aplica automaticamente restrições ao número de chamadas que podem ser feitas através do produto de API. Também tem de adicionar políticas de quota aos proxies de API referenciados pelo produto de API para garantir que o valor da quota definido ao nível do produto de API é aplicado.

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

Por 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>

Quando anexa a política de quotas a um proxy de API, as variáveis de fluxo ratelimit.* são preenchidas, conforme descrito em Depurar a política de quotas e na referência das variáveis de fluxo da política de quotas.

Para mais informações, consulte: