Como usar a ferramenta de depuração para problemas com a monetização

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Faça a depuração da monetização com a ferramenta conforme descrito nas seções a seguir.

Como depurar a fase de política de autenticação

A monetização da Apigee usa a política VerifyAPIKey ou VerifyAccessToken para determinar se uma solicitação de entrada é monetizável verificando o plano de taxas publicado ativo. Para mais informações sobre como adicionar a política, consulte Como adicionar uma política de autenticação.

A imagem a seguir mostra os detalhes da fase da política VerifyAPIKey no fluxo de solicitação.

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

Após a autenticação do usuário, a política VerifyAPIKey verifica todos os planos de taxas publicados para determinar quais estão ativos com base nos períodos de ativação e expiração. Se um plano de taxas publicado for encontrado, as seguintes variáveis de fluxo são preenchidas:

Variável de fluxo	Configuração
`mint.mintng_is_apiproduct_monetized`	`true`, se o plano de tarifas publicado ativo for encontrado
`mint.mintng_rate_plan_id`	ID do plano de tarifas.
`mint.rateplan_end_time_ms`	Período de expiração do plano de taxas. Por exemplo: `1619433556408`
`mint.rateplan_start_time_ms`	Período de ativação do plano de taxas. Por exemplo: `1618433956209`

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

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

Como depurar a fase da política MonetizationLimitsCheck

A monetização da Apigee usa a política MonetizationLimitsCheck para aplicar assinaturas de desenvolvedor ao produto de API. Para mais informações sobre como adicionar a política, consulte Como aplicar assinaturas de desenvolvedor a produtos de API.

Observação: a política MonetizationLimitsCheck não terá efeito se nenhum plano de taxas publicado for encontrado e a variável de fluxo mint.mintng_is_apiproduct_monetized estiver definida como false.

A imagem detalhes da fase da política MonetizationLimitsCheck no fluxo de solicitação.

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

Se o desenvolvedor comprou uma assinatura no produto de API, as seguintes variáveis de fluxo são preenchidas:

Variável de fluxo	Descrição
`mint.limitscheck.is_request_blocked`	`true` para solicitações bloqueadas.
`mint.limitscheck.is_subscription_found`	`true`, se uma assinatura de API for encontrada
`mint.limitscheck_purchased_product_name`	Nome do produto de API comprado. Por exemplo: `MyProduct`
`mint.limitscheck.status_message`	Mensagem de status. Por exemplo: `limits_check_success`
`mint.prepaid_developer_balance`	Saldo atual na carteira da conta pré-paga do desenvolvedor associada à moeda do plano de tarifas.
`mint.prepaid_developer_currency`	Moeda do saldo disponível na variável `mint.prepaid_developer_balance`.
`mint.subscription_end_time_ms`	Horário de término da assinatura do produto de API.
`mint.subscription_start_time_ms`	Horário de início da assinatura do produto de API. Por exemplo: `1618433956209`

Se o desenvolvedor não tiver comprado uma assinatura do produto de API:

a variável de fluxo mint.limitscheck_is_subscription_found é definida como false;
mint.limitscheck.is_request_blocked é definida como true;
nenhuma outra variável de fluxo é preenchida.

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

Como depurar a fase da política Quota

A monetização da Apigee usa a política Quota para aplicar as cotas definidas no nível do produto da API. As cotas definem o número de solicitações permitidas para um produto de API em um determinado período. Para mais informações sobre como adicionar a política, consulte Como aplicar cotas de monetização em proxies de API.

A imagem abaixo mostra os detalhes da fase da política Quota no fluxo de solicitação em que a cota foi excedida.

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

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

Como depurar a fase de política do DataCapture

A Apigee usa as variáveis de monetização capturadas pela política do DataCapture para classificação, cálculo da participação na receita e análise. Para mais informações sobre como capturar as variáveis de monetização na política, consulte Como capturar dados de monetização.

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

Fase de execução da política do DataCapture com as variáveis do fluxo de monetização

Se não houver erros ao capturar as variáveis de monetização, as seguintes variáveis de fluxo serão preenchidas para uma transação:

Variável de fluxo	Descrição
`mint.mintng_currency`	Moeda para calcular a receita. Essa variável de fluxo tem o valor da variável de monetização `currency`.
`mint.mintng_price`	Receita para calcular a participação do desenvolvedor. Essa variável de fluxo tem o valor da variável de monetização `revShareGrossPrice`.
`mint.mintng_price_multiplier`	Fator (multiplicador) pelo qual o custo por transação é multiplicado. Essa variável de fluxo tem o valor `perUnitPriceMultiplier` variável de monetização.
`mint.mintng_tx_success`	Especifica se a transação é monetizada. Essa variável de fluxo tem o valor da variável de monetização `transactionSuccess`.

Como depurar a fase de execução do proxy da API monetizada

Após a execução bem-sucedida do proxy da API monetizada, um conjunto de variáveis de fluxo será preenchido com informações sobre as taxas de monetização por consumo e as taxas cobradas.

Por exemplo, a imagem a seguir mostra os detalhes da fase de Execução do proxy no fluxo PostClient, em que as variáveis são preenchidas.

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

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

Variável de fluxo	Descrição
`message.status.code`	Código de status HTTP da mensagem de resposta do destino. Se você tiver alguma política na resposta, o valor dessa variável será substituído pelo código de status retornado pela política.
`mint.limitscheck.is_request_blocked`	Sinalização que especifica se a solicitação de API está bloqueada.
`mint.mintng_consumption_pricing_rates`	Taxas baseadas em consumo definidas no plano de tarifas.
`mint.mintng_consumption_pricing_type`	Tipo de preço com base no consumo definido no plano de tarifas. Por exemplo: `FIXED_PER_UNIT`
`mint.mintng_dev_share`	Receita a ser compartilhada com o desenvolvedor.
`mint.mintng_price_multiplier`	Fator (multiplicador) capturado da política do DataCapture. O custo por transação é multiplicado por esse fator.
`mint.mintng_rate`	Taxa cobrada pela chamada de API.
`mint.mintng_rate_before_multipliers`	Taxa cobrada pela chamada de API sem o cálculo de `perUnitPriceMultiplier`.
`mint.mintng_revenue_share_rates`	São as taxas de compartilhamento de receita definidas no plano de tarifas.
`mint.mintng_revenue_share_type`	Tipo de participação na receita definido no plano de taxas.
`mint.prepaid_updated_developer_usage`	Uso atual do desenvolvedor pré-pago
`mint.status`	Status da chamada com monetização. Preenchido apenas em caso de erro.
`mint.status_code`	Código de status HTTP da chamada monetizada. Preenchido apenas em caso de erro.
`mint.tx_success_result`	Indica se a monetização foi bem-sucedida para a transação.

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