Konfigurowanie powiadomienia o limitach w planie stawek

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Możesz powiadamiać deweloperów e-mailem, gdy zbliżają się do określonego limitu w przypadku zakupionego planu taryfowego z przedziałami ilościowymi lub pakietowego. Jeśli na przykład deweloperzy kupią plan z przedziałami ilościowymi obejmujący 1000 wywołań w pakiecie, możesz ich powiadomić, gdy osiągną 800 wywołań (80% wykorzystania) lub gdy wydadzą 500 USD na wywołania interfejsu API.

Aby skonfigurować powiadomienie o limicie w przypadku planu taryfowego za pomocą interfejsu API:

1. Dostosuj szablon powiadomienia, który będzie używany do powiadamiania dewelopera.
2. Skonfiguruj warunek i działanie powiadomienia.

Dostosowywanie szablonu powiadomienia

Poniżej znajdziesz przykład dostosowania szablonu powiadomienia, który będzie używany do powiadamiania dewelopera. Więcej informacji znajdziesz w artykule Zarządzanie 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 działania powiadomienia

Skonfiguruj warunek i działanie powiadomienia za pomocą interfejsu API zgodnie z opisem w artykule Konfigurowanie warunków i działań powiadomień za pomocą interfejsu API.

Aby aktywować powiadomienie o limicie planu taryfowego, ustaw te atrybuty:

• RATEPLAN – typ powiadomienia do wysłania.
• PUBLISHED – ustaw ten atrybut na TRUE, aby aktywować powiadomienia o opublikowanych planach taryfowych.

Następnie określ jeden z tych atrybutów:

• Transactions – liczba transakcji. Na przykład powiadom deweloperów, gdy osiągną 800 transakcji. Musi to być liczba całkowita, a dozwolone są tylko operatory > i = dozwolone.
• FeeExposure – kwota w dolarach lub punktach zgromadzona w transakcjach. Musi to być liczba całkowita, a dozwolone są tylko operatory > i =. FeeExposure nie obejmuje opłat za konfigurację, opłat cyklicznych ani opłat za rozwiązanie umowy. Na przykład powiadom deweloperów gdy koszt transakcji interfejsu API osiągnie 500 USD. FeeExposure obliczenia różnią się w zależności od stawki podatku.

Ten ładunek aktywuje powiadomienie e-mail, 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