Migration des développeurs vers la monétisation

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Si vous devez migrer vers la monétisation pour certains de vos développeurs:

  1. 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 encore. Pour en savoir plus, consultez les pages suivantes :
  2. Publiez les plans tarifaires, comme décrit dans la section Publier des plans tarifaires.
  3. Ajoutez les nouveaux développeurs à votre organisation, comme indiqué dans Enregistrer les développeurs d'applications.
  4. Créditez le solde prépayé de chaque développeur, comme décrit dans Gérer les soldes prépayés de comptes.
  5. Acceptez le plan tarifaire, comme décrit dans la section Plans tarifaires d'achat à l'aide de l'API.

    Remarque: Pour renoncer aux frais de configuration, si un développeur a déjà été facturé, définissez le paramètre de requête waivefees sur true.

  6. Si un développeur que vous migrez possède déjà des transactions, vous pouvez transférer manuellement l'utilisation de ces 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 ne dispose d'aucune transaction, vous pouvez ignorer cette étape.

    La ressource transactions insère une transaction unique qui reflète l'utilisation actuelle de la transaction 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, vous pouvez définir l'utilisation des transactions sur 1 000 pour capturer l'activité actuelle. Pour ce faire, appelez la ressource transactions et définissez la propriété batchSize 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 requises ou non.

    Propriété Description Par défaut Requis ?
    application

    ID de l'application du développeur.

    N/A Oui
    batchSize

    Nombre de transactions que vous souhaitez transférer.

    1 Non
    custAttn

    Valeur de l'attribut personnalisé utilisé avec batchSize pour calculer l'utilisation de la transaction.

    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:

    N/A Oui
    product

    ID du produit API.

    N/A Oui
    type

    Doit être défini sur CHARGE (valeur par défaut).

    CHARGE Non

    Pour ignorer les étapes de validation et définir de force le nombre de transactions, définissez le paramètre de requête force sur true (par exemple, ?force=true). Par défaut, les étapes ?force=false et les étapes de validation sont exécutées. Par exemple, si le solde d'un développeur prépayé est nul et que l'activité du compte est suspendue, si ?force=false, la requête échoue 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:password
    

    La 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, batchSize est défini sur 125, et la valeur du premier attribut personnalisé défini pour le produit API est définie sur 0.1. Lorsqu'il est multiplié, 125 * 0,1 équivaut à 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
    
  7. Si la configuration nécessaire ou des frais récurrents ne sont pas facturés au développeur, vous pouvez facturer manuellement 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é de frais de configuration ou récurrents, vous pouvez ignorer cette étape. L'appel de la ressource transactions n'a aucune incidence sur les frais de configuration ni sur les frais 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 afin de facturer manuellement des frais de configuration ou récurrents pour un plan tarifaire, leurs valeurs par défaut et si elles sont requises ou non.

    Propriété Description Par défaut Requis ?
    currency

    Devise utilisée pour le plan tarifaire. Indiquez le code ISO 4217 de la devise, par exemple usd pour le dollar américain ou chf pour le franc suisse.

    N/A Oui
    developer

    ID du développeur.

    N/A Oui
    rate

    Frais de configuration ou frais récurrents à facturer.

    N/A Oui
    ratePlan

    Identifiant du plan tarifaire.

    N/A Oui
    type

    Définissez-la sur SETUPFEES ou RECURRINGFEES.

    CHARGE Oui

    Pour ignorer les étapes de validation et forcer la facturation des frais, définissez le paramètre de requête force sur true (par exemple, ?force=true). Par défaut, ?force=false et les étapes de validation sont exécutées. Par exemple, si le solde d'un développeur prépayé est nul et que l'activité du compte est suspendue, si ?force=false, la demande échouera lors de la validation.

    Par exemple, la requête suivante facture des frais de configuration de 10 USD 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