Limitbenachrichtigung für Preisplan einrichten

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Sie können Entwickler per E-Mail benachrichtigen, wenn sie sich einem bestimmten Limit eines von ihnen erworbenen Volumenband- oder Paketpreislistenplans nähern oder diesen erreicht haben. Wenn Entwickler beispielsweise einen Volumenband-Tarif mit 1.000 Aufrufen in einem Bundle kaufen, können Sie sie benachrichtigen, wenn 800 Aufrufe (80% Nutzung) erreicht wurden oder wenn sie 500 $für API-Aufrufe ausgegeben haben.

So richten Sie mithilfe der API eine Limitbenachrichtigung für einen Tarifplan ein:

1. Passe die Benachrichtigungsvorlage an, die für die Benachrichtigung des Entwicklers verwendet wird.
2. Benachrichtigungsbedingung und -aktion konfigurieren

Benachrichtigungsvorlage anpassen

Im Folgenden findest du ein Beispiel für die Anpassung der Benachrichtigungsvorlage, die für die Benachrichtigung des Entwicklers verwendet wird. Weitere Informationen findest du 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 mithilfe der API, wie unter Benachrichtigungsbedingungen und Aktionen mit der API konfigurieren beschrieben.

Legen Sie die folgenden Attribute fest, um die Benachrichtigung über ein Preisplanlimit auszulösen:

• RATEPLAN: Art der zu sendenden Benachrichtigung.
• PUBLISHED: Legen Sie dieses Attribut auf TRUE fest, um Benachrichtigungen zu veröffentlichten Preisplänen auszulösen.

Geben Sie dann eines der folgenden Attribute an:

• Transactions: Anzahl der Transaktionen Entwickler können beispielsweise informiert werden, wenn 800 Transaktionen erreicht wurden. Muss eine Ganzzahl sein und nur die Operatoren „>“ und „=“ sind zulässig.
• FeeExposure: Betrag in US-Dollar oder Punkte, die bei Transaktionen angesammelt wurden. Muss eine Ganzzahl sein und nur die Operatoren „>“ und „=“ sind zulässig. FeeExposure beinhaltet keine Gebühren für Einrichtung, wiederkehrende oder Kündigungen. Entwickler können beispielsweise informiert werden, wenn die Kosten ihrer API-Transaktionen 500 $erreichen. Die FeeExposure-Berechnungen hängen vom Steuersatz ab.

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