Configurer un plan de notification ajustable

<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 un plan de notification ajustable, le fournisseur d'API peut ajuster le nombre cible de pour chaque développeur d'applications. Vous pouvez configurer si et quand les notifications sont envoyées en fonction lorsqu'un pourcentage du nombre cible est atteint (par exemple, 90%, 100 % ou 150 %). Autres transactions ne sont pas bloquées une fois le nombre cible atteint.

Configuration d'un plan de notification ajustable à l'aide de l'UI

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

Edge

Pour configurer un plan de notification ajustable à l'aide de l'interface utilisateur Edge, lors de l'ajout ou de la modification d'une fréquence sélectionnez le type de forfait Adjustable Notification et, dans la section Adjustable Notification, configurez les informations suivantes:

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

Si vous avez défini des attributs personnalisés pour votre produit API, vous pouvez configurer un paramètre d'évaluation personnalisée afin de 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.
  • Regroupez plusieurs appels d'API en une seule transaction.
    Dans ce cas, sélectionnez "Utiliser un paramètre de note personnalisée", 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 (cloud privé)

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

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

    Consultez la section Créer un plan tarifaire à l'aide de l'interface utilisateur. pour accéder à la fenêtre "Plan tarifaire".

  2. Définissez le champ Période de renouvellement sur le nombre de mois au cours desquels le forfait est renouvelé automatiquement (sauf si le développeur met fin au contrat avant cette date). Si Si vous définissez cette valeur sur 0, le forfait reste actif jusqu'à ce que le développeur décide de le mettre fin.
  3. Cliquez sur Détails sous "Plan tarifaire générique".
  4. Définissez la Base d'agrégation sur la période de temps au cours de laquelle le volume les transactions sont agrégées. Sélectionnez un nombre compris entre 1 et 24 mois. La valeur par défaut est 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. Consultez Publier des plans tarifaires pour découvrir des informations sur la définition de la date de publication et la publication du plan.

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

Configuration d'un plan de notification ajustable à l'aide de l'API

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

Pour spécifier un plan de notifications 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 base d'agrégation, avec durationType Pour les plans de fréquence de notifications ajustables, définissez la valeur sur un nombre entier comprise entre 1 et 24.
durationType

Définissez la période de base d'agrégation, avec durationType Pour les forfaits avec fréquence de notifications ajustable, définissez cette valeur à MONTH.

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

Par exemple, ce qui suit définit un plan de notification ajustable avec une base d'agrégation définie sur "1 month" (1 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 la cible Nombre de transactions par développeur d'applications utilisant l'API

Pour chaque développeur d'applications ayant accepté le forfait de notifications ajustable : 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'applications lorsque celui-ci accepte le plan tarifaire, et vous pourrez 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 quotaTarget dans le corps de la requête dans une requête POST adressée à 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 l'application. développeur. Si aucune valeur n'est spécifiée, le champ 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 l'application développeur 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 PUT vers /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} ressource. Définissez quotaTarget sur un entier positif ou sur 0 pour désactiver des notifications pour le développeur de l'application. Si aucune valeur n'est spécifiée, le champ quotaTarget est défini par défaut sur 0.

Le {developer_rateplan_id} est renvoyé dans la réponse lorsque vous acceptez les 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 tarif développeur plan en envoyant une demande GET /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, où {developer_id} est l'adresse e-mail du développeur. Pour plus d'informations, Voir la section Afficher tous les plans tarifaires acceptés par les développeurs.

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 \
"{ 
   &quot;id&quot; : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   &quot;developer&quot;:{
     "id": "dev@monentreprise.com"
   },
   &quot;ratePlan&quot;:{
     &quot;id&quot;:&quot;p1_adjustable-notification-plan&quot;
   },
   "startDate": "15-04-2016 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}". 
&quot;https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1&quot;
-u email:password