Limitbenachrichtigung für Preisplan einrichten

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation.
Weitere Informationen

Sie können Entwickler per E-Mail benachrichtigen, wenn sie ein bestimmtes Limit fast oder vollständig erreicht haben eines gekauften Volumen- oder Paket-Preislistenplans. Wenn Entwickler beispielsweise einen Volumen-Band-Tarif mit 1.000 Anrufen in einem Paket kaufen,können Sie Ihre Kunden benachrichtigen, wenn sie 800 Aufrufe (Nutzung von 80 %) oder wenn 500 $für API-Aufrufe ausgegeben wurden

Führen Sie die folgenden Schritte aus, um mithilfe der API eine Limitbenachrichtigung für einen Preisplan einzurichten:

  1. Passen Sie die Benachrichtigungsvorlage an, die für die den Entwickler zu benachrichtigen.
  2. Konfigurieren Sie die Benachrichtigungsbedingung und -aktion.

Benachrichtigungsvorlage anpassen

Nachfolgend finden Sie ein Beispiel für die Anpassung der Benachrichtigungsvorlage, die damit der Entwickler benachrichtigt wird. Weitere Informationen finden Sie unter Verwalten Benachrichtigungsvorlagen mithilfe der API erstellen.

$ 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 Konfigurieren von Bedingungen und Aktionen für Benachrichtigungen mithilfe der API.

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

  • RATEPLAN – Art der zu sendenden Benachrichtigung.
  • PUBLISHED – Setzen Sie dieses Attribut auf TRUE, um Benachrichtigungen auszulösen bei veröffentlichten Tarifplänen.

Geben Sie dann eines der folgenden Attribute an:

  • Transactions: Anzahl der Transaktionen. Benachrichtigen Sie Entwickler beispielsweise, wenn werden 800 Transaktionen erzielt. Muss eine Ganzzahl und darf nur > sein und = sind die Operatoren Zulässig sind.
  • FeeExposure: Betrag in Dollar oder Punkten, die bei Transaktionen gesammelt wurden. Muss sein ein ganzzahliger Wert und nur > und = zulässig sind. FeeExposure enthält keine Beträge für Einrichtungsgebühren oder wiederkehrende Gebühren oder Kündigungsgebühren. Benachrichtigen Sie z. B. Entwickler sobald die Kosten ihrer API-Transaktionen 500 $erreichen. FeeExposure Berechnungen variieren je nach Steuersatz.

Die folgende Nutzlast löst eine E-Mail-Benachrichtigung aus, wenn die Anzahl der Transaktionen 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