Benachrichtigungen mithilfe von Benachrichtigungsvorlagen einrichten

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

Was sind Benachrichtigungsvorlagen?

Die Monetarisierung bietet eine Reihe von Vorlagen, mit denen Beispieltext für verschiedene Ereignistypen definiert wird Benachrichtigungen. Sie können jede dieser Vorlagen für folgende Zwecke anpassen:

• Alle Entwickler über Ereignisse wie neue Produkte, neue Versionen von Nutzungsbedingungen oder neue Tarifplänen.
• Benachrichtigen Sie die betroffenen Entwickler über Ereignisse, z. B. einen überarbeiteten Tarifplan.
• Einen API-Anbieter über entwicklerbezogene Ereignisse informieren, z. B. wenn sich ein Entwickler registriert oder wenn sich ein Entwickler für einen Preisplan anmeldet.
• Benachrichtigen Sie alle Administratoren des Unternehmens über einen bestimmten Termin.

Alternativ können Sie einen Webhook erstellen, der einen HTTP-Callback-Handler definiert, die Bedingung, die den Webhook auslöst, wie unter Benachrichtigungen einrichten mit Webhooks.

Die Seite „Benachrichtigungen“

Rufen Sie die Seite „Benachrichtigungen“ wie unten beschrieben auf.

Benachrichtigungen bearbeiten

So bearbeiten Sie eine Benachrichtigung über die Benutzeroberfläche:

1. Rufen Sie die Seite Benachrichtigungen auf.
2. Klicken Sie neben der Benachrichtigung, die Sie bearbeiten möchten, auf , um die Details zu maximieren.
3. Bearbeiten Sie die Felder „Betreff“, „Text“ und „Empfänger“ (falls verfügbar) nach Bedarf.

   Informationen zu Variablen, die in einer Benachrichtigungsvorlage angegeben werden können, finden Sie unter Variablen in Benachrichtigungsvorlagen verwenden.

   In den folgenden Abschnitten finden Sie weitere Informationen zum Bearbeiten von Benachrichtigungen in den einzelnen Kategorien:

   • Benachrichtigungen zur Benachrichtigung aller Entwickler bearbeiten
   • Benachrichtigungen zur Benachrichtigung betroffener Entwickler bearbeiten
   • Benachrichtigungen für das Benachrichtigen von API-Anbietern bearbeiten
4. Aktivieren Sie das Kontrollkästchen daneben, um eine Benachrichtigung zu aktivieren.
5. Wiederholen Sie die Schritte 2 bis 4, um weitere Benachrichtigungen zu bearbeiten.
6. Klicken Sie auf Speichern, um alle Änderungen zu speichern.

Es wird eine Meldung angezeigt, in der bestätigt wird, dass die Benachrichtigungen wurden gespeichert. Der Speichervorgang kann einige Minuten dauern.

Benachrichtigungen bearbeiten, um alle Entwickler zu benachrichtigen

Benachrichtigungen für die Ereignistypen, die Sie im Feld Alle Entwickler benachrichtigen an alle Entwickler gesendet.

Die Benachrichtigungen werden planmäßig am Ende des Tages gesendet. Nachdem die Benachrichtigungen werden die Terminkästchen automatisch deaktiviert. Sie müssen sie zum Planen noch einmal auswählen Benachrichtigungen für die verknüpften Ereignistypen.

In der folgenden Tabelle sind die Benachrichtigungen basierend auf den Ereignistypen im Abschnitt „Alle Entwickler benachrichtigen“ aufgeführt. Weitere Informationen finden Sie unter Benachrichtigungen über die Benutzeroberfläche bearbeiten.

Benachrichtigungen bearbeiten, um betroffene Entwickler zu benachrichtigen

Benachrichtigungen für die Ereignistypen, die Sie in der Spalte Betroffene Benachrichtigungen Entwickler werden nur an die Entwickler gesendet, die von diesen Arten von Ereignissen betroffen sind. Wenn Sie beispielsweise das Ereignis „Überarbeiteter Preisplan“ auswählen, wird eine Benachrichtigung nur an den Entwicklern, die den Preisplan akzeptiert haben.

In der folgenden Tabelle sind die Benachrichtigungen basierend auf den Ereignistypen im Bereich Betroffene Entwickler informieren aufgeführt. Weitere Informationen finden Sie unter Benachrichtigungen über die Benutzeroberfläche bearbeiten.

Benachrichtigungen für das Benachrichtigen von API-Anbietern bearbeiten

Benachrichtigungen für die Ereignistypen, die Sie unter Notify API Provider (API-Anbieter benachrichtigen) auswählen an den von Ihnen angegebenen API-Anbieter gesendet.

In der folgenden Tabelle sind die Benachrichtigungen basierend auf den Ereignistypen im Abschnitt „Notify API Provider“ (API-Anbieter benachrichtigen) aufgeführt. Weitere Informationen finden Sie unter Benachrichtigungen über die Benutzeroberfläche bearbeiten.

Benachrichtigungen aktivieren oder deaktivieren

So aktivieren oder deaktivieren Sie eine Benachrichtigung über die Benutzeroberfläche:

1. Rufen Sie die Seite Benachrichtigungen auf.
2. Aktivieren oder deaktivieren Sie eine Benachrichtigung, indem Sie das Kontrollkästchen daneben aktivieren bzw. deaktivieren.
3. Klicken Sie auf Speichern, um alle Änderungen zu speichern.

Der Speichervorgang kann einige Minuten dauern. Es wird eine Meldung angezeigt, in der bestätigt wird, dass die Benachrichtigungen wurden gespeichert.

Benachrichtigungen mithilfe von Vorlagen und der API einrichten

Richten Sie Benachrichtigungen mithilfe der API ein, wie in den folgenden Abschnitten beschrieben.

Benachrichtigungsvorlagen mithilfe der API verwalten

Verwalten Sie Benachrichtigungsvorlagen mithilfe der API, wie in den folgenden Abschnitten beschrieben:

• Alle Benachrichtigungsvorlagen mithilfe der API ansehen
• Benachrichtigungsvorlage mithilfe der API ansehen
• Benachrichtigungsvorlage mithilfe der API bearbeiten

Alle Benachrichtigungsvorlagen mithilfe der API ansehen

Du kannst alle von der Monetarisierung bereitgestellten Benachrichtigungsvorlagen auflisten, indem du einen GET-Vorgang ausführst. Anfrage an /mint/organizations/{org_name}/notification-email-templates. Beispiel:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

Im Folgenden finden Sie beispielsweise eine Ereignisvorlage, die Entwickler über die Verfügbarkeit eines neuen API-Produkts:

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

Benachrichtigungsvorlage mithilfe der API ansehen

Eine Benachrichtigungsvorlage anzeigen, indem Sie eine GET-Anfrage an /mint/organizations/{org_name}/notification-email-templates/{template_id}, Dabei ist {template_id} die ID der Vorlage. Beispiel:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

Die Elemente in den Vorlagen, die mit $ beginnen, sind Variablen. Weitere Informationen finden Sie unter Variablen in Benachrichtigungsvorlagen verwenden. Angenommen, die Variablen in den einer Benachrichtigung den folgenden Werten entsprechen:

• ${developer.legalName}.XYZ company
• ${developer.name}.DEV1
• ${QUOTA_TYPE}.Transactions
• ${PERCENT}.90%
• ${QUOTA_UNIT}.Calls
• ${QUOTA_LIMIT}.100
• ${ratePlan.monetizationPackage.products.name}.X
• ${EXPIRY_DATE}.2016-09-30

Die durch die Vorlage bereitgestellte Benachrichtigungsnachricht lautet:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

Benachrichtigungsvorlage mithilfe der API bearbeiten

Eine Benachrichtigungsvorlage bearbeiten, indem Sie eine PUT-Anfrage an /nint/organizations/{org_name}/notification-email-templates/{template_id} Geben Sie den geänderten Inhalt der Vorlage im Anfragetext an.

Wenn Sie die Nachricht in einer Benachrichtigungsvorlage anpassen, können Sie eine oder mehrere Variablen. Weitere Informationen finden Sie unter Variable in Benachrichtigung verwenden Vorlagen.

Mit der folgenden Anfrage wird beispielsweise der Inhalt einer neuen API-Produktbenachrichtigung bearbeitet:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

Benachrichtigungsbedingungen und Aktionen über die API verwalten

Verwalten Sie Benachrichtigungsbedingungen und -aktionen über die wie in den folgenden Abschnitten beschrieben.

• Benachrichtigungsbedingung und -aktion mithilfe der API erstellen
• Benachrichtigungsbedingung und -aktion mithilfe der API ansehen
• Benachrichtigungsbedingung und -aktion mithilfe der API bearbeiten
• Benachrichtigungsbedingung und -aktion über die API löschen

Benachrichtigungsbedingung und -aktion mithilfe der API erstellen

Erstellen Sie eine Benachrichtigungsbedingung und eine Aktion, die zu einer automatischen Benachrichtigung führt, indem Sie Folgendes ausgeben: eine POST-Anfrage an /mint/organizations/{org_name}/notification-conditions.

Wenn Sie die Anfrage stellen, geben Sie im Anfragetext die Bedingung an, die zur sowie die Aktionen, die ausgeführt werden sollen, wenn die Bedingung erreicht ist (z. B. das Senden einer Benachrichtigungs-E-Mail).

Sie definieren die Details der Benachrichtigungsbedingung, indem Sie ein oder mehrere Attribute angeben Werte. Eine Liste finden Sie unter Konfigurationseigenschaften für Benachrichtigungsbedingungen. von Attributen. Für eine Ereignisbenachrichtigung kann die Bedingung ausgelöst werden, wenn ein neues Produkt veröffentlicht.

Verwenden Sie beim Definieren des actions die entsprechende Benachrichtigungsvorlage. Weitere Informationen finden Sie unter Konfigurationseigenschaften für Benachrichtigungsaktionen für eine Liste von Aktionen.

Die folgende Anfrage gibt beispielsweise an, dass, wenn das Attribut NEW_PRODUCT und der Wert des Attributs PUBLISHED ist true, sende die Benachrichtigung mit der ID in der Vorlage 01191bf9-5fdd-45bf-8130-3f024694e63 (dies ist die DEFAULT_NEW_PRODUCT_TEMPLATE.

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

Benachrichtigungsbedingung und -aktion mithilfe der API ansehen

Rufen Sie eine Benachrichtigungsbedingung und -aktion auf, indem Sie eine GET-Anfrage an organizations/{org_name}/notification-conditions/{condition_Id}, wobei {condition_Id} ist die ID der Bedingung. Die ID wird zurückgegeben, wenn Sie den Benachrichtigungsbedingung. Beispiel:

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort:

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

Benachrichtigungsbedingung und -aktion mithilfe der API bearbeiten

Benachrichtigungsbedingung und -aktion bearbeiten, indem Sie eine POST-Anfrage an organizations/{org_name}/notification-conditions/{condition_Id}, wobei {condition_Id} ist die ID der Bedingung. Die ID wird zurückgegeben, wenn Sie den Benachrichtigungsbedingung. Wenn Sie die Anfrage senden, geben Sie im Anfragetext die Änderungen an, die Sie an die Benachrichtigungsbedingung oder -aktion vornehmen möchten.

Beispiel:

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

Benachrichtigungsbedingung und -aktion über die API löschen

Benachrichtigungsbedingung löschen, indem Sie eine DELETE-Anfrage an organizations/{org_name}notification-conditions/{condition_Id} Beispiel:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

Konfigurationseigenschaften für Benachrichtigungsbedingungen

Die folgenden Konfigurationseigenschaften für Benachrichtigungsbedingungen sind bei Verwendung der API verfügbar.

Konfigurationseigenschaften für Benachrichtigungsaktionen

Die folgenden Konfigurationseigenschaften stehen bei Verwendung der API für Benachrichtigungsaktionen zur Verfügung.

Variablen in Benachrichtigungsvorlagen verwenden

Wenn Sie die Nachricht in einer Benachrichtigungsvorlage bearbeiten, können Sie eine oder mehrere Variablen einfügen. unter Verwendung der Spring Expression Language (SpEL), um in der Transaktion zurückgegebene Werte darzustellen -Objekt enthält.

In der folgenden Tabelle sind die am häufigsten verwendeten Variablen für Benachrichtigungsvorlagen zusammengefasst.