Configurer une notification de limite pour un plan tarifaire

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

Vous pouvez informer les développeurs par e-mail lorsqu'ils sont sur le point ou ont atteint une certaine limite d'un forfait auquel ils ont souscrit avec une limite de volume ou un forfait groupé. Par exemple, si un développeur souscrit un forfait avec bandes sur volume comportant 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 permettra d'informer 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 permettra d'informer le développeur. Pour en savoir plus, consultez 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 notification

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

Pour déclencher la notification d'une limite du 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.

Ensuite, spécifiez l'un des attributs suivants:

• Transactions : nombre de transactions. Par exemple, informez les développeurs lorsqu'ils atteignent 800 transactions. Doit être un nombre entier, et seuls les opérateurs > et = sont autorisés.
• FeeExposure : montant des dollars ou des points accumulés avec les transactions. Doit être un nombre entier. Seuls les opérateurs > et = sont autorisés. FeeExposure n'inclut pas les frais de configuration, de paiement récurrents et de résiliation. Par exemple, vous pouvez informer les développeurs lorsque le coût de leurs transactions d'API atteint 500 $. Les calculs de 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