Configurer une notification de limite pour un plan tarifaire

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

Vous pouvez informer les développeurs par e-mail lorsqu'ils approchent ou ont atteint une certaine limite d'un forfait avec tarifs groupés ou groupés en volume qu'il a souscrit. Par exemple, si les développeurs si vous souscrivez un forfait avec bandes de 1 000 appels, vous pouvez les avertir 800 appels (80% d'utilisation) ou lorsqu'ils ont dépensé 500 $en appels d'API.

Pour configurer une notification de limite pour un plan tarifaire à l'aide de l'API, procédez comme suit:

1. Personnalisez le modèle de notification qui sera utilisé pour avertir le développeur.
2. Configurez la condition et l'action de notification.

Personnaliser le modèle de notification

Vous trouverez ci-dessous un exemple de personnalisation du modèle de notification qui sera utilisé pour avertir le développeur. Pour en savoir plus, consultez la page Gérer modèles de notification à l'aide de l'API.

$ curl -H "Content-Type: application/json " -X POST -d \    
'{
    "name": "RATE_PLAN_LIMIT_TEMPLATE",
    "subject": "Nearing your rate plan limit",
    "htmlImage": "<p>Hi ${developer.name} - Wanted to let you know that you have used 800 API calls from your ${ratePlan.displayName} rate plan, which started on ${ratePlan.startDate} under the ${ratePlan.monetizationPackage.displayName} package and ${ratePlan.monetizationPackage.products.displayName} product. Just a friendly reminder that your API calls will be charged double after you cross 1000 calls. Thanks for using the API!</p>",
    "source": "Postman API call"
    }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
    -u email:password

Configurer la condition et l'action de notification

Configurez une condition et une action de notification à l'aide de l'API, comme décrit dans la section Configuration les conditions et les actions de notification à l'aide de l'API.

Pour déclencher la notification d'une limite de plan tarifaire, définissez les attributs suivants:

• RATEPLAN : type de notification à envoyer.
• PUBLISHED : définissez cet attribut sur "TRUE" afin de déclencher des notifications sur les plans tarifaires publiés.

Spécifiez ensuite l'un des attributs suivants:

• Transactions : nombre de transactions. Par exemple, vous pouvez informer les développeurs ils atteignent 800 transactions. La valeur doit être un nombre entier et uniquement le signe > et = sont des opérateurs autorisé.
• FeeExposure : montant des dollars ou des points accumulés lors de transactions. Doit être une valeur entière et uniquement > et = sont autorisés. FeeExposure n'inclut pas les frais de configuration, récurrents ou de résiliation. Par exemple, notifier les développeurs lorsque le coût de leurs transactions API atteint 500 $. Calculs FeeExposure varient en fonction du taux de taxe.

La charge utile suivante déclenche une notification par e-mail lorsque le nombre de transactions atteint 800:

$ curl -H "Content-Type:application/json" -X POST -d \
    '{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "{RATE_PLAN_ID}"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "Transactions",
        "value": "= 800"
      }     
    ],
   "actions": [{
          "actionAttribute": "DEV_ID",
          "value": "ANY",
          "templateId": "{EMAIL_TEMPLATE_ID}"
        }]
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
    -u email:password