Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu
Apigee X. info
Sie können Entwickler per E-Mail benachrichtigen, wenn sie sich einem bestimmten Limit eines von ihnen erworbenen Tarifpakets mit Mengenrabatt oder eines Bundle-Tarifpakets nähern oder dieses Limit erreicht haben. Wenn Entwickler beispielsweise ein Tarifpaket mit Mengenrabatt mit 1.000 Aufrufen in einem Bundle erwerben, können Sie sie benachrichtigen, wenn sie 800 Aufrufe (80% Nutzung) erreichen oder 500 $ für API-Aufrufe ausgegeben haben.
So richten Sie eine Limitbenachrichtigung für ein Tarifpaket mit der API ein:
- Passen Sie die Benachrichtigungsvorlage an, die verwendet wird, um den Entwickler zu benachrichtigen.
- Konfigurieren Sie die Benachrichtigungsbedingung und -aktion.
Benachrichtigungsvorlage anpassen
Im Folgenden finden Sie ein Beispiel dafür, wie Sie die Benachrichtigungsvorlage anpassen können, die verwendet wird, um den Entwickler zu benachrichtigen. Weitere Informationen finden Sie unter Benachrichtigungsvorlagen mit der API verwalten.
$ 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
Benachrichtigungsbedingung und -aktion konfigurieren
Konfigurieren Sie eine Benachrichtigungsbedingung und -aktion mit der API, wie unter Konfigurieren von Benachrichtigungsbedingungen und -aktionen mit der API beschrieben.
Legen Sie die folgenden Attribute fest, um die Benachrichtigung für ein Tarifpaketlimit auszulösen:
RATEPLAN- Art der zu sendenden Benachrichtigung.PUBLISHED- Setzen Sie dieses Attribut auf „TRUE“, um Benachrichtigungen für veröffentlichte Tarifpakete auszulösen.
Geben Sie dann eines der folgenden Attribute an:
Transactions- Anzahl der Transaktionen. Benachrichtigen Sie Entwickler beispielsweise, wenn sie 800 Transaktionen erreichen. Muss ein ganzzahliger Wert sein und nur die Operatoren „>“ und „=“ sind zulässig.FeeExposure- Betrag in Dollar oder Punkten, der bei Transaktionen angefallen ist. Muss ein ganzzahliger Wert sein und nur die Operatoren „>“ und „=“ sind zulässig.FeeExposureenthält keine Einrichtungs-, wiederkehrenden oder Kündigungsgebühren. Benachrichtigen Sie Entwickler beispielsweise wenn die Kosten ihrer API-Transaktionen 500 $ erreichen.FeeExposureBerechnungen variieren je nach Steuersatz.
Die folgende Nutzlast löst eine E-Mail-Benachrichtigung aus, wenn die Anzahl der Transaktionen 800 erreicht:
$ 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