Aplicar limites de monetização em proxies de API

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

Anexar a política de verificação dos limites de monetização aos proxies de API para impor limites de monetização. Especificamente, a política é acionada nas seguintes condições:

  • O desenvolvedor que acessa a API monetizada não está registrado ou não se inscreveu no plano de tarifas.
  • O desenvolvedor excedeu o volume de transações para o plano de preços assinado.
  • O saldo pré-pago da conta do desenvolvedor ou o limite de crédito pós-pago foi atingido.

A política de verificação de limites de monetização foi criada para identificar falhas e bloquear chamadas de API em situações como as listadas acima. A política estende a política "Levantar falhas" (consulte Política de aviso de falha) e você pode personalizar a mensagem retornada. As condições aplicáveis são derivadas de variáveis de negócios.

Como anexar uma política de verificação de limites de monetização usando a interface

Para impor limites de monetização, é preciso anexar uma política de verificação dos limites de monetização ao fluxo de solicitação em proxies de API que acessam suas APIs. A política de verificação de limites de monetização precisa ser anexada após qualquer política VerifyAPIKey ou AccessTokenValidation na solicitação.

É possível anexar uma política de verificação de limites de monetização ao criar um proxy de API ou após a criação de um proxy de API.

Ao criar um proxy de API, conforme descrito em Criar um proxy de API simples, se a monetização estiver instalada, a seção "Configuração de monetização" vai aparecer no assistente.

Edge

Na página Políticas comuns do assistente, marque a caixa de seleção Aplicar limites de monetização para anexar uma política de verificação dos limites de monetização.

Política de verificação dos limites de monetização

Na página Resumo do assistente, as Políticas são resumidas. Verifique se a política de monetização está listada, indicando que ela será anexada ao proxy de API, conforme descrito abaixo.

Borda clássica (nuvem privada)

Na página Segurança do assistente, marque a caixa de seleção Ativar a verificação dos limites de monetização para anexar uma política de verificação dos limites de monetização.

Política de verificação dos limites de monetização

A política de verificação de limites de monetização é adicionada ao pré-fluxo da solicitação de ProxyEndpoint, após a chave VerifyAPI ou política AccessTokenValidation, conforme mostrado na figura a seguir.

Para adicionar a política de verificação de limites de monetização a um proxy de API já criado:

  1. No Editor de proxy da API, clique em PreFlow para o endpoint de proxy padrão.
  2. No fluxo de solicitação, clique em +Etapa.
  3. Selecione "Verificação dos limites de monetização" na categoria "Mediação".

  4. Modifique os campos na caixa de diálogo "Add Step", conforme desejado, e clique em Add.

A política é anexada ao fluxo de solicitação após qualquer chave VerifyAPI ou política AccessTokenValidation e será aplicada em mensagens de solicitação de apps clientes para o pré-fluxo do ProxyEndpoint.

Para mais informações sobre como configurar o arquivo XML da política MonetizationLimitsCheck, consulte política MonetizationLimitsCheck.