Configurer le plan tarifaire avec des attributs personnalisés

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

Introduction

Dans certains cas, vous pouvez avoir besoin que les compteurs de transactions soient basés sur une variable ou une valeur personnalisée. Par exemple, vous devrez peut-être:

• Facturer aux développeurs un montant variable en fonction d'une valeur fournie dans le message d'une API . Par exemple, vous pouvez facturer les développeurs d'applications en fonction du nombre d'octets transmis dans la requête API.
• Regroupez plusieurs appels d'API en une seule transaction.

Les plans tarifaires avec des attributs personnalisés vous permettent d'identifier une valeur dans le message d'une API qui sert de compteur et qui est utilisé pour calculer le nombre et les frais des transactions.

Les plans tarifaires suivants avec des attributs personnalisés sont acceptés:

• Tableau des tarifs avec attribut personnalisé
• Notification ajustable avec un attribut personnalisé

Vous pouvez définir jusqu'à 10 attributs personnalisés par plan tarifaire.

Comprendre les calculs d'attributs personnalisés

Intégration de la valeur de l'attribut personnalisé dans le nombre et les frais de transactions du plan tarifaire dépend du modèle de facturation, comme résumé dans le tableau suivant.

Où le plan tarifaire obtient-il valeur de l'attribut personnalisé

La règle d'enregistrement des transactions (sur l'offre groupée de produits d'API) indique à la monétisation où chercher dans pour la valeur de l'attribut personnalisé. Vous définissez l'attribut personnalisé dans la section "Attributs personnalisés". de la règle d'enregistrement des transactions pour le lot de produits API.

Vous pouvez ensuite sélectionner cet attribut personnalisé dans le plan tarifaire (après avoir créé une API). un lot de produits contenant la règle d'enregistrement des transactions attribut personnalisé défini.

Voici le processus général:

1. Définissez les attributs personnalisés lorsque vous ajoutez un produit API.
2. Créez un lot de produits d'API contenant le produit.
   Dans la règle d'enregistrement des transactions du lot de produits de l'API, ajoutez les attributs personnalisés qui seront pour définir des plans tarifaires.
3. Créez un plan tarifaire de type "Tableau des tarifs" ou "Notification ajustable". pour le lot de produits de l'API et spécifiez un paramètre d'évaluation personnalisée.

La figure suivante illustre la relation entre l'attribut personnalisé défini dans la la règle d'enregistrement des transactions et la configuration du plan du tableau des tarifs. La La relation entre les notifications ajustables et les plans tarifaires d'attributs personnalisés est similaire, bien que la valeur de bande passante de volume ne soit pas applicable.

Générer l'attribut personnalisé valeur d'attribut dans le message

La règle d'enregistrement des transactions peut rechercher la valeur de l'attribut personnalisé à plusieurs endroits, telles que l'en-tête de la réponse, le corps de la réponse ou les variables de flux prédéfinies dans la réponse. (La demande n'est pas disponible, car une transaction n'est pas officielle tant que vous n'avez pas reçu response.) Les exemples ci-dessous vous montrent comment ajouter un en-tête de réponse avec sa valeur numérique au message. Dans les deux cas, nous utiliserons la règle Affecter un message avec des variables.

Ajouter la taille de la charge utile de requête à l'en-tête de réponse

Dans chaque demande de message, il existe une variable client.received.content.length qui contient le nombre d'octets dans la charge utile de la requête. En joignant une stratégie "Attribuer des messages" du point de terminaison du proxy, nous pouvons générer un en-tête de réponse nommé messageSize, contient la valeur de longueur:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Ajouter une valeur d'attribut personnalisé d'application à l'en-tête

De la même manière, nous pouvons générer un en-tête avec la valeur d'un attribut personnalisé sur une application. Par exemple, si vous incluez un attribut personnalisé appelé apprating pour chaque développeur application, comme suit:

Lorsque vous utilisez la règle Verify API Key (qui est requise pour la monétisation), cette valeur est stocké dans une variable appelée verifyapikey.{policy_name}.apprating. Utilisation de la fonction Stratégie de message associée à la réponse du point de terminaison du proxy, vous pouvez générer un en-tête appelé apprating contenant la valeur apprating de l'application:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Configurer le plan tarifaire

En dehors de la configuration des attributs personnalisés décrite ci-dessus, le plan tarifaire est configuré de la même manière comme vous le feriez habituellement (pour les plans tarifaires sans attributs personnalisés), mais vous devez respecter les les exigences suivantes.

Configuration d'un plan de tableau des tarifs avec un attribut personnalisé dans l'interface utilisateur

Configurez les plans de tableau des tarifs avec des attributs personnalisés à l'aide de l'interface utilisateur Edge ou Classic Edge, comme décrit dans les sections suivantes.

Configuration d'un plan de notifications ajustable avec des attributs personnalisés à l'aide de l'UI

Spécifier les détails d'un plan tarifaire avec des attributs personnalisés à l'aide de l'API

Effectuez les étapes préalables suivantes:

1. Dans les règles d'enregistrement des transactions d'un produit API, ajoutez les attributs personnalisés pour définir des plans tarifaires. Pour en savoir plus, reportez-vous à l'introduction de cette rubrique et à l'article Créer une transaction règle d'enregistrement. Procédez ainsi pour chaque produit d'API que vous souhaitez inclure dans le package d'API.
2. Une fois que les produits d'API et les règles d'enregistrement des transactions sont configurés exactement souhaitez les obtenir, créez un package d'API contenant le produit. Consultez la section Créer des packages d'API.

Vous allez ensuite utiliser l'API pour créer le plan tarifaire.

Vous spécifiez les détails d'un plan tarifaire avec des attributs personnalisés lorsque vous le créez. Toi spécifiez les détails dans la propriété ratePlanDetails dans le corps de la requête, dans une à /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Dans vous spécifiez une valeur de paramètre "rating" qui identifie le nom de la . Vous pouvez également spécifier une valeur de paramètre "rating" qui regroupe l'attribut personnalisé sur un intervalle de temps spécifié.

Voir Plan tarifaire paramètres de configuration des détails du plan tarifaire pour obtenir la liste complète des options de détails du plan tarifaire.

L'exemple suivant permet de créer un tableau des tarifs avec un plan d'attributs personnalisés, en fonction d'un tableau des tarifs nommé messageSize (voir les éléments en gras).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

L'exemple suivant crée une notification ajustable avec un plan tarifaire pour un attribut personnalisé en fonction d'un attribut personnalisé nommé messageSize (voir l'élément en gras).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "messageSize",
           "ratingParameterUnit": "MB",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password