Cette page s'applique à Apigee et à Apigee hybrid.
Consultez la documentation d'Apigee Edge.
Pour déboguer la monétisation à l'aide de l'outil Debug, consultez les sections suivantes.
Déboguer la phase de règle d'authentification
La monétisation Apigee utilise la règle VerifyAPIKey ou VerifyAccessToken pour déterminer si une requête entrante est monétisable en vérifiant le plan tarifaire publié actif. Pour en savoir plus sur l'ajout de la règle, consultez la section Ajouter une règle d'authentification.
Par exemple, l'image suivante montre les détails de la phase de règle VerifyAPIKey dans le flux de requête.
Après l'authentification de l'utilisateur, la règle VerifyAPIKey vérifie tous les plans tarifaires publiés pour déterminer, le cas échéant, lequel est actif en fonction de leurs délais d'activation et d'expiration. Si un plan tarifaire actif est détecté, les variables de flux suivantes sont renseignées :
Variable de flux | Paramètre |
---|---|
mint.mintng_is_apiproduct_monetized |
true si un plan tarifaire publié actif est détecté. |
mint.mintng_rate_plan_id |
Identifiant du plan tarifaire. |
mint.rateplan_end_time_ms |
Délai d'expiration du plan tarifaire. Par exemple : 1619433556408 |
mint.rateplan_start_time_ms |
Heure d'activation du plan tarifaire. Par exemple : 1618433956209 |
Si aucun plan tarifaire publié actif n'est trouvé, la variable de flux mint.mintng_is_apiproduct_monetized
est définie sur false
et les variables de flux supplémentaires ne sont pas renseignées.
Pour plus d'informations, consultez la section sur les variables de flux mint.
Déboguer la phase de règle MonetizationLimitsCheck
La monétisation Apigee utilise la règle MonetizationLimitsCheck pour appliquer des abonnements de développeur au produit d'API. Pour plus d'informations sur l'ajout de la règle, consultez la section Appliquer des abonnements développeurs aux produits d'API.
Par exemple, l'image suivante montre les détails de la phase de règle MonetizationLimitsCheck dans le flux de requête.
Si le développeur a souscrit un abonnement au produit d'API, les variables de flux suivantes sont renseignées :
Variable de flux | Description |
---|---|
mint.limitscheck.is_request_blocked |
true pour les requêtes bloquées. |
mint.limitscheck.is_subscription_found |
true si un abonnement à l'API est détecté. |
mint.limitscheck_purchased_product_name |
Nom du produit d'API acheté. Par exemple : MyProduct |
mint.limitscheck.status_message |
Message d'état. Par exemple : limits_check_success |
mint.prepaid_developer_balance |
Solde actuel du portefeuille de compte prépayé du développeur associé à la devise du plan tarifaire. |
mint.prepaid_developer_currency |
Devise du solde disponible dans la variable mint.prepaid_developer_balance . |
mint.subscription_end_time_ms |
Heure de fin de l'abonnement au produit d'API. |
mint.subscription_start_time_ms |
Heure de début de l'abonnement au produit d'API. Par exemple : 1618433956209 |
Si le développeur n'a pas souscrit d'abonnement au produit d'API :
- La variable de flux
mint.limitscheck_is_subscription_found
est définie surfalse
. mint.limitscheck.is_request_blocked
est définie surtrue
.- Aucune autre variable de flux n'est renseignée.
Pour plus d'informations, consultez la section sur les variables de flux mint.
Déboguer la phase de règle de quota
La monétisation Apigee utilise la règle de quota pour appliquer les quotas définis au niveau du produit d'API. Les quotas définissent le nombre de requêtes autorisées pour un produit d'API sur une période donnée. Pour plus d'informations sur l'ajout de la règle, consultez la section Appliquer des quotas de monétisation dans des proxys d'API.
Par exemple, l'image suivante montre les détails de la phase de règle de quota dans le flux de requête où le quota a été dépassé.
Dans cet exemple, le quota a été dépassé, un état HTTP 429 Too Many Requests
est renvoyé, et les variables de flux ratelimit.*
sont renseignées pour fournir plus de détails sur l'exception de quota. Pour obtenir une description de ratelimit.*
, consultez la section variables de flux de la règle de quota.
Déboguer la phase de règle Datacapture
Apigee utilise les variables de monétisation capturées par la règle DataCapture pour l'évaluation, le calcul du partage des revenus et l'analyse. Pour plus d'informations sur la capture des variables de monétisation dans la règle, consultez la section Capturer les données de monétisation.
Par exemple, l'image suivante montre les détails de la phase d'exécution de la règle DataCapture dans le flux de réponse.
Si aucune erreur ne se produit lors de la capture des variables de monétisation, les variables de flux suivantes sont renseignées pour une transaction :
Variable de flux | Description |
---|---|
mint.mintng_currency |
Devise utilisée pour calculer les revenus. Cette variable de flux a la valeur de la variable de monétisation |
mint.mintng_price |
Revenus servant à calculer la part du développeur. Cette variable de flux a la valeur de la variable de monétisation |
mint.mintng_price_multiplier |
Facteur (multiplicateur) par lequel le coût par transaction est multiplié. Cette variable de flux a la valeur de la variable de monétisation |
mint.mintng_tx_success |
Indique si la transaction est monétisée. Cette variable de flux a la valeur de la variable de monétisation |
Déboguer la phase d'exécution du proxy d'API monétisé
Une fois que le proxy d'API monétisé est exécuté avec succès, un ensemble de variables de flux est renseigné avec des informations sur les frais de monétisation basés sur la consommation et sur les taux appliqués.
Par exemple, l'image suivante montre les détails de la phase d'exécution du proxy dans le flux PostClient dans lequel les variables sont renseignées.
Si l'exécution du proxy d'API monétisé a réussi, les variables de flux suivantes sont renseignées :
Variable de flux | Description |
---|---|
message.status.code |
Code d'état HTTP du message de réponse de la cible.
Si vous avez une règle dans votre réponse, la valeur de cette variable est remplacée par le code d'état renvoyé par la règle. |
mint.limitscheck.is_request_blocked |
Option indiquant si la requête API est bloquée. |
mint.mintng_consumption_pricing_rates |
Frais basés sur la consommation définis dans le plan tarifaire. |
mint.mintng_consumption_pricing_type |
Type de tarification basée sur la consommation défini dans le plan tarifaire. Par exemple : FIXED_PER_UNIT |
mint.mintng_dev_share |
Revenus à partager avec le développeur. |
mint.mintng_price_multiplier |
Facteur (multiplicateur) capturé à partir de la règle DataCapture. Le coût par transaction est multiplié par ce facteur. |
mint.mintng_rate |
Taux facturés pour l'appel d'API. |
mint.mintng_rate_before_multipliers |
Tarif facturé pour l'appel d'API sans le calcul de perUnitPriceMultiplier . |
mint.mintng_revenue_share_rates |
Taux de partage des revenus défini dans le plan tarifaire. |
mint.mintng_revenue_share_type |
Type de partage des revenus défini dans le plan tarifaire. |
mint.prepaid_updated_developer_usage |
Utilisation actuelle du développeur disposant d'une réserve prépayée. |
mint.status |
État de l'appel monétisé. Renseigné seulement en cas d'erreur. |
mint.status_code |
Code d'état HTTP de l'appel monétisé. Renseigné seulement en cas d'erreur. |
mint.tx_success_result |
Indique si la monétisation est réussie pour la transaction. |
Pour obtenir une description détaillée de toutes les variables, consultez la section sur les variables de flux mint.