Aplicar limites de monetização em proxies de API

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
info

Anexe a política de verificação de limites de monetização aos proxies de API para aplicar os 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 assinou o plano de preços.
  • O desenvolvedor excedeu o volume de transações do plano de preços assinado.
  • O saldo da conta pré-paga ou o limite de crédito pós-pago do desenvolvedor foi atingido.

A política de verificação de limites de monetização foi projetada para gerar uma falha e bloquear uma chamada de API em situações como as listadas acima. A política estende a política de geração de falhas (consulte Política de geração de falhas) 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 aplicar limites de monetização, uma política de verificação de limites de monetização precisa ser anexada ao fluxo de solicitações 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 depois que um proxy de API é criado.

Ao criar um proxy de API, conforme descrito em Criar um proxy de API simples, se a monetização estiver instalada, a seção de 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 de limites de monetização.

Política de verificação de 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 a política de verificação de limites de monetização será anexada ao proxy de API, conforme descrito abaixo.

Edge clássico (nuvem privada)

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

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

A política de verificação de limites de monetização é adicionada ao PreFlow de solicitação do ProxyEndpoint, após a política VerifyAPI Key ou 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 que já foi criado:

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

  4. Modifique os campos na caixa de diálogo "Adicionar etapa" conforme desejado e clique em Adicionar.

A política é anexada ao fluxo de solicitações após qualquer política VerifyAPI Key ou AccessTokenValidation e será aplicada a mensagens de solicitação de apps clientes ao PreFlow do ProxyEndpoint.

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