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 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 tarifa.
  • O desenvolvedor excedeu o volume de transações do plano de taxa 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 Raise Fault (consulte Política Raise Fault), 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çã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 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.

Nova interface do Edge (nuvem privada)

  1. Faça login na nova interface do Edge em http://host:3001/edge, em que host é o endereço IP ou o nome DNS do host que executa a nova interface do Edge.
  2. Selecione Desenvolver > Proxies de API na barra de navegação à esquerda e clique em +Proxy para abrir o assistente "Criar proxy".
  3. 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

  4. Na página Resumo do assistente, 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.

A política de verificação de limites de monetização é adicionada ao PreFlow de solicitação do ProxyEndpoint, depois da política VerifyAPIKey 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 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 "Adicionar etapa" conforme necessário e clique em Adicionar.

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

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