Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
Si vous avez des développeurs existants que vous devez migrer vers la monétisation :
- Créez les produits d'API, les packages d'API et les plans tarifaires pour les développeurs que vous migrez, s'ils n'existent pas déjà. Pour en savoir plus, consultez les pages suivantes :
- Publiez les plans tarifaires, comme décrit dans Publier des plans tarifaires.
- Ajoutez les nouveaux développeurs à votre organisation, comme décrit dans Enregistrer des développeurs d'applications.
- Créditez le solde prépayé de chaque développeur, comme décrit dans la section Gérer les soldes des comptes prépayés.
- Acceptez le plan tarifaire, comme décrit dans la section Acheter des plans
tarifaires à l'aide de l'API.
Remarque : Pour renoncer aux frais de configuration si un développeur a déjà été facturé, définissez le
waivefeesparamètre de requête surtrue. - Si un développeur que vous migrez a des transactions existantes,
vous pouvez transférer manuellement l'utilisation des transactions à l'aide de la ressource suivante :
/organizations/{org_name}/transactions, où{org_name}est le nom de l'organisation.Remarque : Si un développeur n'a pas de transactions existantes, vous pouvez ignorer cette étape.
La ressource
transactionsinsère une seule transaction qui reflète l'utilisation actuelle des transactions et met à jour tous les compteurs internes pour refléter cette nouvelle valeur.Par exemple, si le développeur a émis 1 000 appels à l'API avant la migration, pour capturer l'activité actuelle, vous pouvez définir l'utilisation des transactions sur 1 000 en appelant la
transactionsressource et en définissant labatchSizepropriété sur 1 000 dans le corps de la requête.Le tableau suivant récapitule les propriétés de configuration que vous pouvez spécifier dans le corps de la requête pour définir manuellement le nombre de transactions, leurs valeurs par défaut et si elles sont obligatoires ou non.
Propriété Description Par défaut Obligatoire ? applicationID de l'application de développeur.
N/A Oui batchSizeNombre de transactions que vous souhaitez transférer.
1 Non custAttnValeur de l'attribut personnalisé utilisé avec batchSize pour calculer l' utilisation des transactions.
Le numéro d'attribut personnalisé dans le message doit être spécifié sous la forme d'une valeur entière positive ou décimale (jusqu'à quatre décimales). Les valeurs négatives ne sont pas autorisées.
L'attribut personnalisé doit être défini dans :
- Règlement concernant l'enregistrement des transactions pour le produit d'API. Consultez la section Configurer un règlement concernant l'enregistrement des transactions.
- Plan tarifaire actif pour le produit d'API. Consultez la section Configurer un plan tarifaire avec des attributs personnalisés.
N/A Oui productID du produit d'API.
N/A Oui typeDoit être défini sur
CHARGE(valeur par défaut).CHARGENon Pour ignorer les étapes de validation et définir de force le nombre de transactions, définissez le
forceparamètre de requête surtrue(par exemple,?force=true). Par défaut,?force=falseet les étapes de validation sont exécutées. Par exemple, si un développeur prépayé a un solde nul et que l'activité sur le compte est suspendue, si?force=false, la requête échouera lors de la validation.Par exemple, la requête suivante définit le nombre de transactions sur 50 pour l'application et le produit d'API spécifiés :
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "application":{ "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b" }, "product":{ "id":"testproduct" }, "batchSize":50 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:passwordLa requête suivante définit l'utilisation des transactions sur 12,5 pour l'application et le produit d'API spécifiés. Dans la requête,
batchSizeest défini sur125et la valeur pour le premier attribut personnalisé défini pour le produit d'API est définie sur0.1. Multipliés ensemble, 125 * 0,1 font 12,5.$ curl -H "Content-Type:application/json" -X POST -d \ '{ "application":{ "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b" }, "product":{ "id":"testproduct" }, "batchSize": 125, "custAtt1" : 0.1 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:password - Si un développeur n'a pas été facturé des frais de configuration ou récurrents nécessaires, vous pouvez manuellement
facturer des frais de configuration ou récurrents pour un plan tarifaire à l'aide de la ressource suivante :
/organizations/{org_name}/transactions, où{org_name}est le nom de l'organisation.Remarque : Si le développeur a déjà été facturé des frais de configuration ou récurrents, vous pouvez ignorer cette étape. L'appel de la ressource
transactionsn'aura pas d'incidence sur les frais de configuration ou récurrents définis par le plan tarifaire.Le tableau suivant récapitule les propriétés de configuration que vous pouvez spécifier dans le corps de la requête pour facturer manuellement des frais de configuration ou récurrents pour un plan tarifaire, leurs valeurs par défaut et si elles sont obligatoires ou non.
Propriété Description Par défaut Obligatoire ? currencyDevise utilisée pour le plan tarifaire. Spécifiez le code ISO 4217 de la devise, par exemple usd pour le dollar américain ou chf pour le franc suisse.
N/A Oui developerID du développeur.
N/A Oui rateFrais de configuration ou récurrents à facturer.
N/A Oui ratePlanIdentifiant du plan tarifaire.
N/A Oui typeDéfinissez-la sur
SETUPFEESouRECURRINGFEES.CHARGEOui Pour ignorer les étapes de validation et facturer de force les frais, définissez le
forceparamètre de requête surtrue(par exemple,?force=true). Par défaut,?force=falseet les étapes de validation sont exécutées. Par exemple, si un développeur prépayé a un solde nul et que l’activité sur le compte est suspendue, si?force=false, la requête échouera lors de la validation.Par exemple, la requête suivante facture des frais de configuration de 10 dollars américains au développeur abonné au plan tarifaire :
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "developer":{ "id":"dev1@myorg.com" }, "currency":{ "id":"usd" }, "ratePlan":{ "id":"mypackage_rateplan1" }, "rate":10, "type":"SETUPFEES" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:password