Configurer une notification de limite pour un plan tarifaire

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

Vous pouvez envoyer une notification par e-mail aux développeurs lorsqu'ils approchent ou ont atteint une certaine limite d'un plan tarifaire à volume ou groupé qu'ils ont acheté. Par exemple, si les développeurs achètent un plan à volume avec 1 000 appels dans un bundle, vous pouvez les avertir lorsqu'ils atteignent 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 la 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 les 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 la notification

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

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

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

Spécifiez ensuite l'un des attributs suivants :

• Transactions : nombre de transactions. Par exemple, avertissez les développeurs lorsqu' ils atteignent 800 transactions. Doit être une valeur entière et seuls les opérateurs > et = sont autorisés.
• FeeExposure : montant en dollars ou en points accumulés sur les transactions. Doit être une valeur entière et seuls les opérateurs > et = sont autorisés. FeeExposure n'inclut pas les frais d'installation, récurrents ni de résiliation. Par exemple, avertissez les développeurs lorsque le coût de leurs transactions d'API atteint 500 $. FeeExposure calculs varient en fonction du taux d'imposition.

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