Migration des développeurs vers la monétisation

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X.
info

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

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

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

  6. 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 ne possède pas encore de transactions, vous pouvez ignorer cette étape.

    La ressource transactions insè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é en cours, vous pouvez définir l'utilisation des transactions sur 1 000 en appelant la ressource transactions et en définissant 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 s'ils sont obligatoires ou non.

    Propriété Description Par défaut Obligatoire ?
    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 des transactions.

    Le numéro de l'attribut personnalisé dans le message doit être spécifié sous la forme d'un nombre entier positif ou décimal (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 d'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, ?force=false et les étapes de validation sont exécutés. Par exemple, si le solde d'un développeur prépayé est nul et que son activité 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: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 de l'API est définie sur 0.1. Lorsque vous multipliez 125 * 0,1, vous obtenez 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 les frais de configuration ou récurrents nécessaires n'ont pas été facturés à un 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 des frais de configuration ou récurrents ont déjà été facturés au développeur, 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 forfait.

    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 requises ou non.

    Propriété Description Par défaut Obligatoire ?
    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 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 facturer les frais de force, 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és. Par exemple, si un développeur prépayé n'a pas de solde et que l'activité sur le 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 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