Aplicar limites de monetização em proxies de API

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

Anexe a política de verificação dos 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 se inscreveu no plano de tarifas.
  • O desenvolvedor excedeu o volume de transações do plano de preço assinado.
  • O limite de crédito pré-pago ou pós-pago da conta do desenvolvedor foi atingido.

A política de verificação dos 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 "Gerar falha" (consulte Política "Gerar 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 aplicar os 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 for 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 "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 dos limites de monetização

Na página "Resumo" do assistente, as políticas são resumidas. Confira se a política de monetização está listada, indicando que a política de verificação dos limites de monetização será anexada ao proxy da API, conforme descrito abaixo.

Edge clássico (nuvem privada)

Na página Segurança do assistente, marque a caixa de seleção Ativar a 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 dos limites de monetização

A política MonetizationLimitsCheck é adicionada ao PreFlow de solicitação do ProxyEndpoint, depois da política VerifyAPIKey ou AccessTokenValidation, como mostrado na figura a seguir.

Para adicionar a política de verificação dos 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 de limites de monetização" na categoria "Mediação".

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

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

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