Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info
Was sind Benachrichtigungsvorlagen?
Die Monetarisierung bietet eine Reihe von Vorlagen, die Beispieltext für verschiedene Arten von Ereignisbenachrichtigungen definieren. Sie können jede dieser Vorlagen anpassen, um
- Alle Entwickler über Ereignisse wie neue Produkte, neue Versionen der Nutzungsbedingungen oder neue Preispläne informieren.
- Betroffene Entwickler über Ereignisse wie einen überarbeiteten Preisplan informieren
- Benachrichtigen Sie einen API-Anbieter über Entwicklerereignisse, z. B. wenn sich ein Entwickler für ein Konto registriert oder für ein Tarifpaket registriert.
- Alle Unternehmensadministratoren über ein bestimmtes Ereignis benachrichtigen.
Alternativ können Sie einen Webhook erstellen, der einen HTTP-Callback-Handler definiert, und dann die Bedingung konfigurieren, die den Webhook auslöst, wie unter Benachrichtigungen mit Webhooks einrichten beschrieben.
Die Seite „Benachrichtigungen“ kennenlernen
Rufen Sie die Seite „Benachrichtigungen“ wie unten beschrieben auf.
Edge
So greifen Sie über die Edge-Benutzeroberfläche auf die Seite „Benachrichtigungen“ zu:
- Melden Sie sich unter apigee.com/edge an.
- Wählen Sie in der linken Navigationsleiste Veröffentlichen > Monetarisierung > Benachrichtigungen aus.
Die Seite „Benachrichtigungen“ wird angezeigt.
Wie in der Abbildung hervorgehoben, können Sie auf der Seite „Benachrichtigungen“ Folgendes tun:
- Details zu Benachrichtigungen maximieren und minimieren
- Details der Benachrichtigung bearbeiten und alle Änderungen speichern
- Benachrichtigungen aktivieren oder deaktivieren
Classic Edge (Private Cloud)
So greifen Sie über die klassische Edge-Benutzeroberfläche auf die Seite „Benachrichtigungen“ zu:
- Melden Sie sich bei
http://ms-ip:9000
an, wobei ms-ip die IP-Adresse oder der DNS-Name des Management Server-Knotens ist. Wählen Sie in der oberen Navigationsleiste Verwaltung > Benachrichtigungen aus.
Auf der Seite „Benachrichtigungen“ haben Sie folgende Möglichkeiten:
Benachrichtigungen bearbeiten
So bearbeiten Sie eine Benachrichtigung über die Benutzeroberfläche:
- Rufen Sie die Seite Benachrichtigungen auf.
- Klicken Sie neben der Benachrichtigung, die Sie bearbeiten möchten, auf , um die Details zu maximieren.
- 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.
Weitere Informationen zum Bearbeiten von Benachrichtigungen in den einzelnen Kategorien finden Sie in den folgenden Abschnitten:
- Aktivieren Sie eine Benachrichtigung, indem Sie das Kästchen daneben anklicken.
- Wiederholen Sie die Schritte 2 bis 4, um weitere Benachrichtigungen zu bearbeiten.
- Klicken Sie auf Speichern, um alle Änderungen zu speichern.
Es wird eine Meldung angezeigt, in der bestätigt wird, dass die Benachrichtigungen gespeichert wurden. Das Speichern kann einige Minuten dauern.
Benachrichtigungen bearbeiten, um alle Entwickler zu benachrichtigen
Benachrichtigungen für die Ereignistypen, die Sie im Abschnitt Alle Entwickler benachrichtigen auswählen, werden an alle Entwickler gesendet.
Die Benachrichtigungen werden am Ende des Tages gesendet. Nachdem die Benachrichtigungen gesendet wurden, werden die Kästchen für die Ereignisse automatisch entfernt. Sie müssen sie noch einmal auswählen, um Benachrichtigungen für die zugehörigen Ereignistypen zu planen.
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.
Ereignistyp | Trigger | Hinweise |
---|---|---|
Neues Paket | Neues API-Paket verfügbar |
Fügen Sie im Rahmen der Aktualisierung den Namen jedes neuen Pakets (und der darin enthaltenen Produkte) in den Textkörper der E-Mail-Vorlage ein. Sie können auch einen Link zum Entwicklerportal oder zu einer anderen Website hinzufügen, auf der weitere Informationen zur Benachrichtigung verfügbar sind. |
Neues Produkt | Neues API-Produkt verfügbar |
Fügen Sie den Namen jedes neuen Produkts im Textkörper der E-Mail-Vorlage als Teil der Aktualisierung hinzu. Sie können auch einen Link zum Entwicklerportal oder zu einer anderen Website hinzufügen, auf der weitere Informationen zur Benachrichtigung verfügbar sind. |
Neue Märkte/Abdeckung | Neue API-Produkte sind in bestimmten geografischen Märkten verfügbar |
Fügen Sie im Rahmen der Aktualisierung den Namen jedes neuen Marktes und die entsprechenden Produkte in den Textkörper der E-Mail-Vorlage ein. Du kannst auch einen Link zum Entwicklerportal oder einer anderen Website hinzufügen, auf der weitere Informationen zur Benachrichtigung verfügbar sind. |
Benachrichtigungen bearbeiten, um betroffene Entwickler zu benachrichtigen
Benachrichtigungen zu den Ereignistypen, die Sie im Abschnitt Betroffene Entwickler benachrichtigen auswählen, werden nur an die Entwickler gesendet, die von diesen Ereignistypen betroffen sind. Wenn Sie beispielsweise das Ereignis „Überarbeiteter Preisplan“ auswählen, wird eine Benachrichtigung nur an die Entwickler gesendet, die den Preisplan akzeptiert haben.
In der folgenden Tabelle sind die Benachrichtigungen nach Ereignistyp im Abschnitt „Benachrichtigte Entwickler“ aufgeführt. Weitere Informationen finden Sie unter Benachrichtigungen über die Benutzeroberfläche bearbeiten.
Ereignistyp | Trigger | Hinweise |
---|---|---|
Angebotsbedingungen nicht akzeptiert oder abgelaufen | Neue Nutzungsbedingungen wurden veröffentlicht und der Entwickler hat sie noch nicht akzeptiert |
Die Benachrichtigung wird 30 Tage, 7 Tage und 1 Tag vor Inkrafttreten der neuen Nutzungsbedingungen gesendet. |
Neuer Preisplan | Neue Tarifpläne werden veröffentlicht |
Wenn das Preismodell ein:
|
Überarbeiteter Preisplan | Neuere Version eines gekauften Tarifpakets verfügbar |
Nur die Entwickler, die die aktuelle Version gekauft haben, werden benachrichtigt. Anhand der Benachrichtigung können die Entwickler die neue Version prüfen und Tarife kündigen oder wechseln, wenn sie die neuen Preise nicht akzeptieren möchten. |
Abgelaufener Preisplan | Preisplan ist abgelaufen und es gibt keinen Folgepreisplan |
Diese Benachrichtigung wird gesendet, wenn Sie das Ablaufdatum des Preisplans ursprünglich festlegen. Zusätzliche Benachrichtigungen werden 30, 7 und 1 Tag vor dem Ablaufdatum gesendet. Nur Entwickler, die das ablaufende Tarifpaket gekauft haben, werden benachrichtigt. |
Verlängerter Preisplan | Das Abo für den Preisplan wurde verlängert. |
Informieren Sie den Entwickler, dass die anfallenden Gebühren in Rechnung gestellt werden. |
Ratenlimit überschritten | Das Limit für den Preisplan wurde überschritten |
Informieren Sie den Entwickler, dass die entsprechenden Gebühren in Rechnung gestellt werden. |
Aufgebrauchter Freemium-Tarif | Die kostenlosen Nutzungszeiträume, gemessen an der Anzahl der Transaktionen oder der Anzahl der Tage, sind aufgebraucht. |
Die kostenlose Nutzungsdauer wird durch Ihren Freemium-Tarif festgelegt. |
Abrechnungsdokument veröffentlicht |
Abrechnungsdokumente (z. B. Rechnungen) für den Entwickler sind verfügbar. |
|
Entwickler registriert sich für ein neues Preismodell | Der Entwickler registriert sich für einen neuen Tarif. |
Benachrichtigungen für das Benachrichtigen von API-Anbietern bearbeiten
Benachrichtigungen zu den Ereignistypen, die Sie im Abschnitt API-Anbieter benachrichtigen auswählen, werden an den von Ihnen angegebenen API-Anbieter gesendet.
In der folgenden Tabelle sind die Benachrichtigungen nach Ereignistyp im Abschnitt „Notify API-Anbieter“ aufgeführt. Weitere Informationen finden Sie unter Benachrichtigungen über die Benutzeroberfläche bearbeiten.
Ereignistyp | Trigger |
---|---|
Neuer Entwickler registriert sich |
Der Entwickler hat sich für ein Konto registriert. |
Entwickler fügt eine App hinzu |
Der Entwickler hat eine neue Anwendung erstellt. |
Entwickler für neuen Preisplan registrieren |
Der Entwickler hat sich für einen Preisplan registriert. |
Der Entwickler ändert die Finanzdetails |
Der Entwickler hat Finanzdetails geändert, z. B. den Namen oder die Adresse seines Unternehmens. |
Benachrichtigungen aktivieren oder deaktivieren
So aktivieren oder deaktivieren Sie eine Benachrichtigung über die Benutzeroberfläche:
- Rufen Sie die Seite „Benachrichtigungen“ auf.
- Sie können eine Benachrichtigung aktivieren oder deaktivieren, indem Sie das Kästchen daneben markieren oder das Häkchen entfernen.
- Klicken Sie auf Speichern, um alle Änderungen zu speichern.
Das Speichern kann einige Minuten dauern. Es wird eine Meldung angezeigt, in der bestätigt wird, dass die Benachrichtigungen gespeichert wurden.
Benachrichtigungen mithilfe von Vorlagen über die API einrichten
Richten Sie Benachrichtigungen mithilfe der API ein, wie in den folgenden Abschnitten beschrieben.
Benachrichtigungsvorlagen mithilfe der API verwalten
Sie können Benachrichtigungsvorlagen mithilfe der API wie in den folgenden Abschnitten beschrieben verwalten:
- Alle Benachrichtigungsvorlagen mit der API ansehen
- Benachrichtigungsvorlage mit der API ansehen
- Benachrichtigungsvorlage mit der API bearbeiten
Alle Benachrichtigungsvorlagen mithilfe der API aufrufen
Du kannst alle Benachrichtigungsvorlagen auflisten, die für die Monetarisierung verfügbar sind, indem du eine GET-Anfrage an /mint/organizations/{org_name}/notification-email-templates
sendest. 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, mit der Entwickler über die Verfügbarkeit eines neuen API-Produkts informiert werden:
{ "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 aufrufen
Sie können eine Benachrichtigungsvorlage aufrufen, indem Sie eine GET-Anfrage an /mint/organizations/{org_name}/notification-email-templates/{template_id}
senden, wobei {template_id}
die ID der Vorlage ist. 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 der Benachrichtigung haben die folgenden Werte:
${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 Benachrichtigungsnachricht, die von der Vorlage bereitgestellt wird, 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 mit der API bearbeiten
Zum Bearbeiten einer Benachrichtigungsvorlage senden 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 einfügen. Weitere Informationen finden Sie unter Variablen in Benachrichtigungsvorlagen verwenden.
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
Sie können Benachrichtigungsbedingungen und -aktionen mithilfe der API wie in den folgenden Abschnitten beschrieben verwalten.
- Benachrichtigungsbedingung und ‑aktion mit der API erstellen
- Benachrichtigungsbedingung und ‑aktion mit der API ansehen
- Bedingung und Aktion für Benachrichtigungen mit der API bearbeiten
- Benachrichtigungsbedingung und ‑aktion mit der API löschen
Benachrichtigungsbedingung und -aktion mithilfe der API erstellen
Erstellen Sie eine Benachrichtigungsbedingung und ‑aktion, die zu einer automatischen Benachrichtigung führt, indem Sie eine POST-Anfrage an /mint/organizations/{org_name}/notification-conditions
senden.
Geben Sie beim Senden der Anfrage im Anfragetext die Bedingung an, die zur Benachrichtigung führt, und die Aktionen, die ausgeführt werden sollen, wenn die Bedingung erfüllt ist (z. B. das Senden einer Benachrichtigungs-E-Mail).
Sie legen die Details der Benachrichtigungsbedingung durch Angabe eines oder mehrerer Attributwerte fest. Eine Liste der Attribute finden Sie unter Konfigurationsattribute für Benachrichtigungsbedingungen. Bei einer Ereignisbenachrichtigung kann die Bedingung ausgelöst werden, wenn ein neues Produkt veröffentlicht wird.
Verweise beim Definieren der actions
auf die entsprechende Benachrichtigungsvorlage. Eine Liste der Aktionen finden Sie unter Konfigurationsattribute für Benachrichtigungsaktionen.
In der folgenden Anfrage wird beispielsweise angegeben, dass die Benachrichtigung in der Vorlage mit der ID 01191bf9-5fdd-45bf-8130-3f024694e63
gesendet werden soll, wenn das Attribut NEW_PRODUCT
und der Wert des Attributs PUBLISHED
true
ist (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
Wenn Sie eine Benachrichtigungsbedingung und ‑aktion aufrufen möchten, senden Sie eine GET-Anfrage an organizations/{org_name}/notification-conditions/{condition_Id}
, wobei {condition_Id}
die ID der Bedingung ist. Die ID wird zurückgegeben, wenn Sie die Benachrichtigungsbedingung erstellen. 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 mit der API bearbeiten
Bearbeiten Sie eine Benachrichtigungsbedingung und ‑aktion, indem Sie eine POST-Anfrage an organizations/{org_name}/notification-conditions/{condition_Id}
senden, wobei {condition_Id}
die ID der Bedingung ist. Die ID wird zurückgegeben, wenn Sie die Benachrichtigungsbedingung erstellen. Geben Sie beim Senden der Anfrage im Anfragetext die Änderungen an der Benachrichtigungsbedingung oder ‑aktion an.
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
Zum Löschen einer Benachrichtigungsbedingung senden 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.
Name | Beschreibung | Standard | Erforderlich? |
---|---|---|---|
attribute |
Details zur Benachrichtigungsbedingung. Sie können ein oder mehrere Attribute angeben, um die Benachrichtigungsbedingung einzugrenzen. Der Wert kann einer oder mehrere der folgenden sein:
|
– | Ja |
value |
Wert des Attributs. |
– | Nein |
associatedCondition |
Verweis auf eine verknüpfte Bedingung. |
– | Nein |
Konfigurationseigenschaften für Benachrichtigungsaktionen
Die folgenden Konfigurationseigenschaften stehen bei Verwendung der API für Benachrichtigungsaktionen zur Verfügung.
Name | Beschreibung | Standard | Erforderlich? |
---|---|---|---|
actionAttribute |
Methode zur Identifizierung des Empfängers der Benachrichtigung. Der Wert kann einer oder mehrere der folgenden sein:
|
– | Ja |
value |
Wert des Aktionsattributs. Wenn Wenn Wenn |
– | Ja |
templateID |
ID der Benachrichtigungsvorlage. Hinweis:Diese Option ist nicht gültig, wenn |
– | Ja |
postURL |
Callback-Handler für den Webhook. Hinweis:Diese Option ist erforderlich, wenn |
– | Ja |
Variablen in Benachrichtigungsvorlagen verwenden
Wenn Sie die Nachricht in einer Benachrichtigungsvorlage bearbeiten, können Sie mithilfe von Spring Expression Language (SpEL) eine oder mehrere Variablen einfügen, um Werte darzustellen, die im Transaktionsobjekt zurückgegeben werden.
In der folgenden Tabelle sind die am häufigsten verwendeten Variablen für Benachrichtigungsvorlagen zusammengefasst.
Variable | Beschreibung |
---|---|
${application.name} |
Name einer Anwendung. |
${application.products.name} |
Name eines Produkts, das in einer Anwendung enthalten ist. |
${BALANCE} |
Guthaben für ein bestimmtes Kontingent. |
${developer.legalName} |
Name des Unternehmens eines Entwicklers. |
${developer.name} |
Name eines Entwicklers. |
${EXPIRY_DATE} |
Datum oder Uhrzeit, zu der ein Limit abläuft oder zurückgesetzt wird. |
${LONG_PERCENT} |
Prozentsatz eines durch die aktuelle Nutzung erreichten Limits ohne %-Symbol. Beispiel: 50 |
${PERCENT} |
Prozentsatz eines Limits, der durch die aktuelle Nutzung erreicht wurde, mit dem Prozentzeichen %. Beispiel: 50%. |
${products.displayName} |
Der für ein Produkt definierte Anzeigename. |
${QUOTA_TYPE} |
Art des Limits (Transaktionsvolumen, Ausgabenlimit oder Gebührenrisiko) |
${QUOTA_UNIT} |
Grundeinheit für ein Limit: Währung (für ein Ausgabenlimit) oder Aufrufe (für ein Transaktionslimit). |
${QUOTA_LIMIT} |
Betrag eines Limits. |
${ratePlan.displayName} |
Für einen Preisplan definierter Anzeigename. |
${ratePlan.endDate} |
Das Datum, an dem ein API-Anbieter ein Preismodell beendet hat. |
${ratePlan.monetizationPackage.displayName} |
Name eines API-Pakets. |
${ratePlan.monetizationPackage.name} |
Name eines Monetarisierungspakets. |
${ratePlan.monetizationPackage.products.displayName} |
Für ein API-Produkt definierter Anzeigename. |
${ratePlan.monetizationPackage.products.name} |
Name eines Produkts, das in einem Monetarisierungspaket enthalten ist. |
${ratePlan.startDate} |
Datum, an dem ein Preisplan erstellt wurde. |
${USAGE} |
Aktuelle Nutzung (Gesamtumsatz oder Gebühren oder Volumen). |
${USER} |
Name eines Nutzers. |
Antwortadresse anpassen
Zur Monetarisierung wird eine Standardadresse vom Typ noreply@apigee.com für E-Mail-Benachrichtigungen konfiguriert, die an Unternehmen und Entwickler gesendet werden. Wenden Sie sich an den Apigee-Support, um einen benutzerdefinierten Antwortnamen und eine benutzerdefinierte Antwortadresse für Ihre Organisation zu konfigurieren.