Migration des développeurs vers la monétisation

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X.
En savoir plus

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 des développeurs que vous représentez. migrer, s'ils n'existent pas déjà. Pour en savoir plus, consultez les pages suivantes: <ph type="x-smartling-placeholder">
  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 Enregistrer des développeurs d'applications.
  4. Créditez la réserve prépayée de chaque développeur, comme indiqué dans la section Gérer les comptes prépayés soldes.
  5. Acceptez le plan tarifaire, tel que décrit dans la section Taux 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 waivefees sur true.

  6. Si un développeur que vous migrez possède des transactions, vous pouvez transférer manuellement l'utilisation des transactions à l'aide de la ressource suivante:
    /organizations/{org_name}/transactions, où {org_name} correspond au le nom de l'organisation.

    Remarque:Si un développeur n'a pas encore de transactions, vous pouvez ignorer cette étape. étape.

    La ressource transactions insère une seule transaction qui reflète le 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 vers l'API avant la migration, pour capturez l'activité en cours. Vous pouvez définir l'utilisation des transactions sur 1 000 en appelant la méthode ressource transactions et en définissant la propriété batchSize sur 1 000 pouces le corps de la requête.

    Le tableau suivant récapitule les propriétés de configuration que vous pouvez spécifier dans l'API de la requête pour définir manuellement le nombre de transactions, leurs valeurs par défaut et mais pas si elles sont obligatoires.

    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 le et l'utilisation des transactions.

    Le numéro de l'attribut personnalisé figurant dans le message doit être un entier positif. 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 forcer la définition du nombre de transactions, définissez le 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é. Par exemple, si le solde et l'activité d'un développeur prépayé sont nuls sur le compte est suspendu. Si la valeur est ?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 la valeur application et produit API:

    $ 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 spécifiée et produit d'API. 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éfini sur 0.1. Quand ? multipliés par 125 * 0,1 = 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 un développeur n'a pas été facturé les frais de configuration nécessaires ou les frais récurrents, 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} correspond au 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 la configuration ni 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 l'API le corps de la requête à facturer manuellement des frais de configuration ou récurrents pour un plan tarifaire, qui sont les valeurs par défaut et si elles sont obligatoires.

    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 forcer la facturation des frais, définissez la 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 une carte prépayée le solde du développeur est nul et l'activité sur son compte est suspendue, ?force=false : la requête échouera lors de la validation.

    Par exemple, dans la requête suivante, des frais de configuration de 10 dollars américains sont facturés au développeur s'est 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