Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Możesz powiadomić deweloperów e-mailem, gdy zbliżą się do określonego limitu objętego limitem lub w ramach pakietu stawek w pakiecie, albo już osiągną określony limit. Jeśli na przykład deweloperzy kupią abonament z limitem ilości z 1000 wywołań w pakiecie, możesz ich powiadomić, gdy osiągną 800 wywołań (wykorzystanie 80%) lub gdy wydają 500 zł na wywołania interfejsu API.
Aby skonfigurować za pomocą interfejsu API powiadomienie o limitach dla planu taryfowego, wykonaj te czynności:
- Dostosuj szablon powiadomień, który będzie używany do powiadamiania dewelopera.
- Skonfiguruj warunek i działanie powiadomienia.
Dostosowywanie szablonu powiadomień
Poniżej znajdziesz przykład, jak dostosować szablon powiadomienia, który będzie używany do powiadamiania dewelopera. Więcej informacji znajdziesz w artykule o zarządzaniu szablonami powiadomień za pomocą interfejsu 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
Konfigurowanie warunku i czynności dotyczącej powiadomienia
Skonfiguruj warunek powiadomienia i działanie przy użyciu interfejsu API zgodnie z opisem w sekcji Konfigurowanie warunków powiadomień i działań przy użyciu interfejsu API.
Aby otrzymywać powiadomienia o limitach w ramach abonamentu, skonfiguruj te atrybuty:
RATEPLAN
– typ powiadomienia do wysłania.PUBLISHED
– ustaw ten atrybut na wartość TRUE, aby aktywować powiadomienia o opublikowanych planach stawek.
Następnie określ jeden z tych atrybutów:
Transactions
– liczba transakcji. Możesz na przykład powiadomić deweloperów, gdy osiągną 800 transakcji. Musi być liczbą całkowitą i dozwolone są tylko operatory > i =.FeeExposure
– kwota w dolarach lub punktach zgromadzonych za transakcje. Musi być liczbą całkowitą i dozwolone są tylko operatory > i =.FeeExposure
nie obejmuje opłat konfiguracyjnych, cyklicznych ani opłat za zerwanie umowy. Możesz na przykład powiadomić deweloperów, gdy koszt ich transakcji API osiągnie 500 USD. Obliczenia wartościFeeExposure
różnią się w zależności od stawki podatku.
Ten ładunek aktywuje e-maila z powiadomieniem, gdy liczba transakcji osiągnie 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