Como 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.

Aplique limites de monetização anexando políticas a proxies de API associados a um produto de API monetizado, conforme descrito nas seções a seguir.

Como adicionar uma política de autenticação

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

Anexe a política VerifyAPIKey ou VerifyAccessToken a um proxy de API de uma das seguintes maneiras:

• Quandocriar um proxy de API usando o assistente "Criar proxy", selecioneChave de API ou OAuth 2.0 na seção Segurança: autorização na página Políticas comuns . Por exemplo:

  

• Ao desenvolver um proxy de API, anexe a política VerifyAPIKey ou VerifyAccessToken ao fluxo de solicitação como a primeira política no Preflow do proxy de API. Por exemplo:

  

Veja mais informações em:

• Como anexar uma política a um fluxo
• Como verificar tokens de acesso
• Como monitorar e depurar a política de autenticação usando o Debug

Como aplicar assinaturas de desenvolvedor a produtos de API

Anexe a política MonetizationLimitsCheck aos proxies de API para aplicar assinaturas de desenvolvedor ao produto de API. Especificamente, a política é acionada se o desenvolvedor do app que acessa a API não tiver comprado uma assinatura do produto de API associado. Nesse caso, a política MonetizationLimitsCheck gera uma falha e bloqueia a chamada 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 a política não terá efeito.

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.

Observação: para evitar que transações específicas sejam faturadas, use a variável de monetização transactionSuccess. Para mais informações sobre como usar a variável transactionSuccess, veja Variáveis de monetização.

Anexe a política MonetizationLimitsCheck a um proxy de API de uma das maneiras a seguir:

• Ao criar um proxy de API usando o assistente "Criar proxy", selecione Aplicar limites de monetização na página Políticas comuns, conforme mostrado na figura a seguir.

  

• Ao desenvolver um proxy de API, anexe a política MonetizationLimitsCheck ao fluxo de solicitação no PreFlow de proxy de API após a política VerifyAPIKey ou VerifyAccessToken, como mostrado na figura a seguir.

  

Veja mais informações em:

• Como criar um proxy de API
• Como anexar uma política a um fluxo
• Como depurar a política MonetizaçãoLimitsCheck usando o Debug
• Política MonetizationLimitsCheck

Como aplicar cotas de monetização em proxies de API

Observação: se você adicionar uma cota depois que o produto de API estiver em uso, o cálculo da cota começará no momento da próxima transação monetizada.

Uma cota define o número de solicitações permitidas para um produto de API em um determinado período Para aplicar as cotas para 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 da API para garantir que o valor da cota definido no nível do produto de API seja aplicado.

Anexe a política de cota a um proxy de API de uma das maneiras a seguir:

• Ao criar um proxy de API usando o assistente "Criar proxy", selecione Impor cotas por app na seção Cotas da página Políticas comuns, como mostrado na figura a seguir.

  

• Ao desenvolver um proxy de API, anexe a política de cota ao fluxo de solicitação no PreFlow de proxy de API após a política VerifyAPIKey ou VerifyAccessToken, como mostrado na figura a seguir.

  

Edite a política de cota para permitir que o elemento <UseQuotaConfigInAPIProduct> use a configuração de cota definida no 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>

Observações:

• É possível definir a configuração padrão <DefaultConfig> a ser usada se a configuração da cota não estiver definida no produto de API. No entanto, a configuração da cota definida no nível do produto da API tem prioridade.
• Quando você adicionar o elemento <UseQuotaConfigInAPIProduct> eà política de cota, a Apigee ignorará qualquer elemento filho <Allow>, <Interval> e <TimeUnit> de <Quota>.

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

Veja mais informações em:

• Como anexar uma política a um fluxo
• Como depurar a política de cotas usando o Debug
• Política de cotas