Configurer un plan de notification ajustable

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

Introduction

Dans un plan de notification ajustable, le fournisseur d'API peut ajuster le nombre cible de transactions pour chaque développeur d'application. Vous pouvez configurer si et quand les notifications sont envoyées based on when a percentage of the target number is reached, such as 90%, 100%, or 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'interface utilisateur

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

Edge

Pour configurer un plan de notification ajustable à l'aide de l'interface utilisateur Edge, lorsque vous ajoutez ou modifiez un plan tarifaire , sélectionnez le type de plan tarifaire Notification ajustable. Dans la section Notification ajustable , configurez les informations suivantes :

Champ Description Par défaut
Fréquence de calcul Période sur laquelle le volume de transactions (ou le volume associé à un attribut personnalisé) est calculé. Sélectionnez un nombre de mois (entre 1 et 24 mois). 1 mois

Si vous avez défini des attributs personnalisés pour votre produit d'API, vous pouvez configurer un paramètre de tarification personnalisé pour définir un compteur de transactions basé sur un attribut personnalisé.

Par exemple, vous devrez peut-être :

  • facturer aux développeurs un montant variable en fonction d'une valeur fournie dans le message d'un appel d'API ;
    Par exemple, vous pouvez facturer les développeurs d'applications en fonction du nombre d'octets transmis dans la requête API.
  • regrouper plusieurs appels d'API en une seule transaction.
    Dans ce cas, sélectionnez "Utiliser un paramètre de tarification personnalisé", puis sélectionnez l'attribut personnalisé dans la liste déroulante.

Pour en savoir plus, consultez Configurer un plan tarifaire avec des attributs personnalisés.

Classic Edge (Private Cloud)

Pour configurer des plans de notification ajustables à l'aide de l'interface utilisateur Classic Edge :

  1. Sélectionnez Notification ajustable dans le champ Type de plan tarifaire de l'onglet "Détails du plan" de la fenêtre "Plan tarifaire".

    Pour savoir comment accéder à la fenêtre "Plan tarifaire", consultez Créer un plan tarifaire à l'aide de l'interface utilisateur.

  2. Définissez le champ Période de renouvellement sur le nombre de mois au bout duquel le plan est automatiquement renouvelé (sauf si le développeur résilie le contrat avant cette date). Si vous définissez cette valeur sur 0, le plan reste en vigueur jusqu'à ce que le développeur choisisse de le résilier.
  3. Cliquez sur Détails sous "Plan tarifaire générique".
  4. Définissez la base d'agrégation sur la période pendant laquelle le volume de transactions est agrégé. Sélectionnez un nombre compris entre 1 et 24 mois. La valeur par défaut est de 1 mois.
  5. Cliquez sur Appliquer et fermer.
  6. Cliquez sur Enregistrer le brouillon.
  7. Ne publiez le plan que lorsque vous êtes absolument sûr qu'il est définitif. Pour savoir comment définir la date de publication et publier le plan, consultez Publier des plans tarifaires pour des informations.

    Une fois que vous avez publié un plan tarifaire, vous ne pouvez modifier que la date de fin. Vous ne pouvez pas supprimer un plan tarifaire après sa publication, mais vous pouvez le faire expirer et le remplacer par un plan tarifaire futur, comme décrit dans Faire expirer un plan tarifaire publié.

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

Spécifiez les détails du plan de notification ajustable dans la ratePlanDetails propriété dans le corps de la requête dans une requête POST à /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Pour spécifier un plan de notification ajustable, spécifiez les valeurs suivantes dans le 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 cet élément sur la période de la base d'agrégation, ainsi que sur durationType. Pour les plans tarifaires de notification ajustables, définissez cette valeur sur un entier valeur comprise entre 1 et 24.
durationType

Définissez cet élément sur la période de la base d'agrégation, ainsi que sur durationType. Pour les plans tarifaires de notification ajustables, définissez cette valeur sur MONTH.

Pour en savoir plus sur les propriétés de configuration qui peuvent être définies lorsque vous spécifiez les détails d'un plan de notification ajustable, consultez Paramètres de configuration des détails du plan tarifaire.

Par exemple, la définition suivante 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'application à l'aide de l'API

Pour chaque développeur d'application ayant accepté le plan tarifaire de notification ajustable, vous devez définir le nombre cible de transactions. Vous pouvez configurer si et quand les notifications sont envoyées en fonction du moment où un pourcentage du nombre cible est atteint, par exemple 90%, 100 % ou 150%. Les transactions supplémentaires ne sont pas bloquées une fois le nombre cible atteint.

Vous pouvez définir le nombre cible de transactions pour un développeur d'application lorsque celui-ci accepte le plan tarifaire, et vous pouvez modifier 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 quotaTarget propriété dans le corps de la requête dans une requête POST à la /organizations/{org_name}/developers/{developer_id}/developer-rateplans ressource. Définissez quotaTarget sur un entier positif ou sur 0 pour désactiver les notifications pour le développeur d'application. Si aucune valeur n'est spécifiée, la valeur par défaut de quotaTarget est 0.

Par exemple, la requête suivante définit le nombre cible de transactions sur 4 000 lorsque le développeur d'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 à la ressource /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Définissez quotaTarget sur un entier positif ou sur 0 pour désactiver les notifications pour le développeur d'application. Si aucune valeur n'est spécifiée, la valeur par défaut de quotaTarget est 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 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 sur 4 000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password