Configurer un plan de notification ajustable

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

Introduction

Dans un plan de notification ajustable, le fournisseur d'API peut ajuster le nombre cible de transactions pour chaque développeur d'applications. Vous pouvez configurer l'envoi des notifications en fonction du pourcentage atteint, par exemple 90%, 100 % ou 150%. Les transactions supplémentaires ne sont pas bloquées une fois le nombre cible atteint.

Configurer un plan de notification ajustable à l'aide de l'UI

Configurez des plans de notification ajustables, comme décrit ci-dessous.

Configurer un plan de notification ajustable à l'aide de l'API

Dans la requête POST que vous envoyez à /organizations/{org_name}/monetization-packages/{package_id}/rate-plans, spécifiez les détails du plan de notification ajustable dans la propriété ratePlanDetails du corps de la requête.

Pour spécifier un plan de notification ajustable, indiquez les valeurs suivantes dans le champ ratePlanDetails du corps de la requête:

Propriété	Valeur
type	Définissez cet élément sur USAGE_TARGET.
meteringType	Définissez cet élément sur DEV_SPECIFIC.
duration	Définissez la période de la base d'agrégation, avec durationType. Pour des plans à taux de notifications ajustables, définissez ce paramètre sur une valeur entière comprise entre 1 et 24.
durationType	Définissez la période de la base d'agrégation, avec durationType. Pour les forfaits de notifications ajustables, définissez cette valeur sur MONTH.

Pour en savoir plus sur les propriétés de configuration pouvant être définies lors de la spécification des détails du plan de notification ajustable, consultez Paramètres de configuration des détails du plan tarifaire.

Par exemple, le code suivant définit un plan de notification ajustable avec une base d'agrégation définie sur un mois.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "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": "VOLUME",
           "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

Définir le nombre cible de transactions pour chaque développeur d'applications à l'aide de l'API

Vous pouvez définir le nombre cible de transactions pour un développeur d'applications lorsque celui-ci accepte le plan tarifaire, puis mettre à jour la valeur ultérieurement.

Définir le nombre cible de transactions lors de l'acceptation du plan tarifaire

Lorsque vous acceptez le plan tarifaire, pour définir le nombre cible de transactions, spécifiez la propriété quotaTarget dans le corps de la requête dans une requête POST adressée à la ressource /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Définissez quotaTarget sur un entier positif ou sur 0 afin de désactiver les notifications pour le développeur de l'application. Si aucune valeur n'est spécifiée, quotaTarget est défini par défaut sur 0.

Par exemple, la requête suivante définit le nombre cible de transactions sur 4 000 lorsque le développeur de l'application accepte le plan de notification ajustable.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Définir le nombre cible de transactions lors de la mise à jour du plan tarifaire accepté

Pour définir le nombre cible de transactions, vous pouvez mettre à jour le plan tarifaire accepté et spécifier la propriété quotaTarget dans le corps de la requête dans une requête PUT adressée à la ressource /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Définissez quotaTarget sur un entier positif ou sur 0 afin de désactiver les notifications pour le développeur de l'application. Si aucune valeur n'est spécifiée, quotaTarget est défini par défaut sur 0.

Le {developer_rateplan_id} est renvoyé dans la réponse lorsque vous acceptez le plan tarifaire publié.

Exemple :

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Vous pouvez également obtenir le {developer-rateplan-id} pour le plan tarifaire du développeur en envoyant une requête GET à /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, où {developer_id} est l'adresse e-mail du développeur. Pour en savoir plus, consultez la section Afficher tous les plans tarifaires acceptés par un développeur.

Exemple :

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

La requête suivante met à jour le nombre cible de transactions à 4 000.

email:password