Depurar a rentabilização com a ferramenta de depuração

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Depure a rentabilização através da depuração, conforme descrito nas secções seguintes.

Depurar a fase da política de autenticação

A rentabilização do Apigee usa a política VerifyAPIKey ou VerifyAccessToken para determinar se um pedido recebido é rentabilizável, verificando o plano tarifário publicado ativo. Para mais informações sobre como adicionar a política, consulte o artigo Adicionar uma política de autenticação.

Por exemplo, a imagem seguinte mostra os detalhes da fase da política VerifyAPIKey no fluxo de pedidos.

Detalhes da fase da política VerifyAPIKey, incluindo as variáveis do fluxo de rentabilização

Após a autenticação do utilizador, a política VerifyAPIKey verifica todos os planos tarifários publicados para determinar qual, se existir, está ativo com base nas respetivas horas de ativação e expiração. Se for encontrado um plano de tarifas publicado ativo, as seguintes variáveis de fluxo são preenchidas:

Variável de fluxo Definição
mint.mintng_is_apiproduct_monetized true se for encontrado um plano de tarifas publicado ativo.
mint.mintng_rate_plan_id ID do plano tarifário.
mint.rateplan_end_time_ms Hora de validade do plano tarifário. Por exemplo: 1619433556408
mint.rateplan_start_time_ms Hora de ativação do plano tarifário. Por exemplo: 1618433956209

Se não for encontrado nenhum plano de tarifas publicado ativo, a variável de fluxo mint.mintng_is_apiproduct_monetized é definida como false e as variáveis de fluxo adicionais não são preenchidas.

Para mais informações, consulte as variáveis de fluxo mint.

Depurar a fase da política MonetizationLimitsCheck

A rentabilização do Apigee usa a política MonetizationLimitsCheck para aplicar as subscrições de programadores ao produto da API. Para mais informações sobre como adicionar a política, consulte o artigo Aplicação de subscrições de programadores a produtos API.

Por exemplo, a imagem seguinte mostra os detalhes da fase da política MonetizationLimitsCheck no fluxo de pedidos.

Detalhes da fase da política MonetizationLimitsCheck, incluindo as variáveis do fluxo de rentabilização

Se o programador comprou uma subscrição do produto API, as seguintes variáveis de fluxo são preenchidas:

Variável de fluxo Descrição
mint.limitscheck.is_request_blocked true para pedidos bloqueados.
mint.limitscheck.is_subscription_found true se for encontrada uma subscrição da API.
mint.limitscheck_purchased_product_name Nome do produto API comprado. Por exemplo: MyProduct
mint.limitscheck.status_message Mensagem de estado. Por exemplo: limits_check_success
mint.prepaid_developer_balance Saldo atual na carteira da conta pré-paga do programador associada à moeda do plano tarifário.
mint.prepaid_developer_currency Moeda do saldo disponível na variável mint.prepaid_developer_balance.
mint.subscription_end_time_ms Hora de conclusão da subscrição do produto API.
mint.subscription_start_time_ms Hora de início da subscrição do produto API. Por exemplo: 1618433956209

Se o programador não comprou uma subscrição do produto API:

  • A variável de fluxo mint.limitscheck_is_subscription_found está definida como false
  • mint.limitscheck.is_request_blocked está definido como true
  • Não são preenchidas outras variáveis de fluxo.

Para mais informações, consulte as variáveis de fluxo mint.

Depurar a fase da política de quotas

A rentabilização do Apigee usa a política de quotas para aplicar as quotas definidas ao nível do produto de API. As quotas definem o número de pedidos permitidos para um produto de API durante um determinado período. Para mais informações sobre como adicionar a política, consulte o artigo Aplicação de quotas de rentabilização em proxies de API.

Por exemplo, a imagem seguinte mostra os detalhes da fase da política de quotas no fluxo de pedidos em que a quota foi excedida.

Detalhes da fase da política de quotas, incluindo as variáveis do fluxo de rentabilização

Neste exemplo, a quota foi excedida, é devolvido um estado HTTP 429 Too Many Requests e as variáveis do fluxo ratelimit.* são preenchidas para fornecer mais detalhes sobre a exceção de quota. Para uma descrição da ratelimit.*, consulte as variáveis de fluxo da política de quotas.

Depurar a fase da política DataCapture

O Apigee usa as variáveis de rentabilização captadas pela política DataCapture para classificação, cálculo da partilha de receita e estatísticas. Para mais informações sobre a captura das variáveis de rentabilização na política, consulte o artigo Capturar dados de rentabilização.

Por exemplo, a imagem seguinte mostra os detalhes da fase de execução da política DataCapture no fluxo de resposta.

Fase de execução da política de captura de dados com as variáveis do fluxo de rentabilização

Se não existirem erros ao capturar as variáveis de rentabilização, as seguintes variáveis de fluxo são preenchidas para uma transação:

Variável de fluxo Descrição
mint.mintng_currency

Moeda para calcular a receita.

Esta variável de fluxo tem o valor da variável de rentabilização currency.
mint.mintng_price

Receita para calcular a quota do programador.

Esta variável de fluxo tem o valor da variável de rentabilização revShareGrossPrice.
mint.mintng_price_multiplier

Fator (multiplicador) pelo qual o custo por transação é multiplicado.

Esta variável de fluxo tem o valor da variável de rentabilização perUnitPriceMultiplier.
mint.mintng_tx_success

Especifica se a transação é rentabilizada.

Esta variável de fluxo tem o valor da variável de rentabilização transactionSuccess.

Depurar a fase de execução do proxy de API rentabilizada

Após a execução bem-sucedida do proxy de API rentabilizado, é preenchido um conjunto de variáveis de fluxo com informações sobre as taxas e as tarifas baseadas no consumo da rentabilização.

Por exemplo, a imagem seguinte mostra os detalhes da fase Proxy Execution no fluxo PostClient, onde as variáveis são preenchidas.

Detalhes da fase de execução do proxy, incluindo as variáveis do fluxo de rentabilização

Se a execução do proxy de API rentabilizada for bem-sucedida, as seguintes variáveis de fluxo são preenchidas:

Variável de fluxo Descrição
message.status.code Código de estado HTTP da mensagem de resposta do destino.

Se tiver alguma política na sua resposta, o valor desta variável é substituído pelo código de estado devolvido pela política.
mint.limitscheck.is_request_blocked Sinalização que especifica se o pedido da API está bloqueado.
mint.mintng_consumption_pricing_rates Taxas baseadas no consumo definidas no plano tarifário.
mint.mintng_consumption_pricing_type Tipo de preço baseado no consumo definido no plano tarifário. Por exemplo: FIXED_PER_UNIT
mint.mintng_dev_share Receita a partilhar com o programador.
mint.mintng_price_multiplier Fator (multiplicador) capturado a partir da política DataCapture. O custo por transação é multiplicado por este fator.
mint.mintng_rate

Tarifa cobrada pela chamada API.
mint.mintng_rate_before_multipliers Tarifa cobrada pela chamada da API sem o cálculo de perUnitPriceMultiplier.
mint.mintng_revenue_share_rates Taxas de partilha de receita definidas no plano de tarifas.
mint.mintng_revenue_share_type Tipo de partilha de receita definido no plano de tarifas.
mint.prepaid_updated_developer_usage Utilização atual do programador pré-pago.
mint.status Estado da chamada rentabilizada. Preenchido apenas em caso de erro.
mint.status_code Código de estado HTTP da chamada rentabilizada. Preenchido apenas em caso de erro.
mint.tx_success_result Indica se a rentabilização é bem-sucedida para a transação.

Para uma descrição detalhada de todas as variáveis, consulte as variáveis do fluxo de cunhagem.