Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Was sind Benachrichtigungsvorlagen?
Die Monetarisierung bietet eine Reihe von Vorlagen zum Definieren von Beispieltexten für verschiedene Arten von Ereignisbenachrichtigungen. Sie können jede dieser Vorlagen für folgende Zwecke anpassen:
- Informieren Sie alle Entwickler über Ereignisse wie neue Produkte, neue Versionen der Nutzungsbedingungen oder neue Preispläne.
- Informieren Sie betroffene Entwickler über Ereignisse wie einen überarbeiteten Tarifplan.
- API-Anbieter über entwicklerbezogene Ereignisse informieren, z. B. wenn sich ein Entwickler für ein Konto anmeldet oder sich für einen Preisplan registriert.
- Alle Administratoren des Unternehmens über ein bestimmtes Ereignis informieren
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 mithilfe von Webhooks einrichten beschrieben.
Die Seite „Benachrichtigungen“
Rufen Sie wie unten beschrieben die Seite „Benachrichtigungen“ auf.
Edge
So greifen Sie über die Edge-Benutzeroberfläche auf die Seite „Benachrichtigungen“ zu:
- Melden Sie sich unter apigee.com/edge an.
- Wähle 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:
- Benachrichtigungsdetails maximieren und minimieren
- Benachrichtigungsdetails bearbeiten und alle Änderungen speichern
- Benachrichtigungen aktivieren oder deaktivieren
Classic Edge (Private Cloud)
So greifen Sie über die Classic Edge-Benutzeroberfläche auf die Seite „Benachrichtigungen“ zu:
- Melden Sie sich bei
http://ms-ip:9000an, wobei ms-ip die IP-Adresse oder der DNS-Name des Knotens des Verwaltungsservers 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.
In den folgenden Abschnitten finden Sie weitere Informationen zum Bearbeiten von Benachrichtigungen in den einzelnen Kategorien:
- Aktivieren Sie das Kontrollkästchen daneben, um eine Benachrichtigung zu aktivieren.
- 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. Der Speichervorgang kann einige Minuten dauern.
Benachrichtigungen werden so bearbeitet, dass alle Entwickler benachrichtigt werden.
Benachrichtigungen für die Ereignistypen, die Sie im Bereich Alle Entwickler benachrichtigen auswählen, werden an alle Entwickler gesendet.
Die Benachrichtigungen werden planmäßig am Ende des Tages gesendet. Nachdem die Benachrichtigungen gesendet wurden, werden die Kästchen für den Termin automatisch wieder 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 nach 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 den Namen jedes neuen Pakets (und der in jedem Paket enthaltenen Produkte) im Rahmen des Updates in den Text der E-Mail-Vorlage ein. Du kannst auch einen Link zum Entwicklerportal oder zu einer anderen Website hinzufügen, die weitere Informationen zur Benachrichtigung enthält. |
| Neues Produkt | Neues API-Produkt verfügbar |
Fügen Sie bei der Aktualisierung den Namen jedes neuen Produkts in den Text der E-Mail-Vorlage ein. Du kannst auch einen Link zum Entwicklerportal oder einer anderen Website hinzufügen, die weitere Informationen zur Benachrichtigung enthält. |
| Neue Märkte/Abdeckung | In bestimmten geografischen Märkten sind neue API-Produkte verfügbar. |
Fügen Sie bei der Aktualisierung den Namen jedes neuen Markts und der entsprechenden Produkte in den Text der E-Mail-Vorlage ein. Du kannst auch einen Link zum Entwicklerportal oder einer anderen Website hinzufügen, die weitere Informationen zur Benachrichtigung enthält. |
Benachrichtigungen zur Benachrichtigung betroffener Entwickler bearbeiten
Benachrichtigungen für die 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 nur an die Entwickler eine Benachrichtigung gesendet, die den Preisplan akzeptiert haben.
In der folgenden Tabelle sind die Benachrichtigungen im Abschnitt Betroffene Entwickler benachrichtigen nach Ereignistypen aufgeführt. Weitere Informationen finden Sie unter Benachrichtigungen über die Benutzeroberfläche bearbeiten.
| Ereignistyp | Trigger | Hinweise |
|---|---|---|
| Nutzungsbedingungen nicht akzeptiert oder abgelaufen | Es wurden neue Nutzungsbedingungen 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 Preispläne werden veröffentlicht |
Wenn der Preisplan:
|
| Überarbeiteter Preisplan | Eine neuere Version eines gekauften Tarifs ist verfügbar |
Nur die Entwickler, die die aktuelle Version erworben haben, werden benachrichtigt. Die Benachrichtigung ermöglicht es den Entwicklern, die neue Version zu prüfen und den Tarif zu kündigen oder zu wechseln, wenn sie die neuen Preise nicht akzeptieren möchten. |
| Abgelaufener Preisplan | Preisplan ist ohne nachträglichen Preisplan abgelaufen |
Diese Benachrichtigung wird gesendet, wenn Sie den Ablauf des Preisplans erstmals festgelegt haben. Zusätzliche Benachrichtigungen werden 30, 7 und 1 Tag vor dem Ablaufdatum gesendet. Nur die Entwickler, die den Preisplan erworben haben, der abläuft, werden benachrichtigt. |
| Verlängerter Preisplan | Das Preisplanabo wurde verlängert. |
Informieren Sie den Entwickler, dass entsprechende Gebühren in Rechnung gestellt werden. |
| Ratenbegrenzung überschritten | Das Preisplanlimit wurde überschritten |
Informieren Sie den Entwickler, dass entsprechende Gebühren in Rechnung gestellt werden. |
| Auf null gesetzter Freemium-Preisplan | Kostenlose Nutzungszeiträume, gemessen an der Anzahl der Transaktionen oder an Tagen, sind aufgebraucht |
Der Zeitraum der kostenlosen Nutzung richtet sich nach Ihrem Freemium-Tarif. |
| Abrechnungsdokument veröffentlicht |
Es sind Abrechnungsunterlagen (z. B. Rechnungen) für den Entwickler verfügbar. |
|
| Entwickler registriert sich für neuen Preisplan | Der Entwickler registriert sich für einen neuen Preisplan. |
Benachrichtigungen zum Benachrichtigen von API-Anbietern bearbeiten
Benachrichtigungen für die Ereignistypen, die Sie im Abschnitt Notify API Provider (API-Anbieter benachrichtigen) auswählen, werden 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.
| Ereignistyp | Trigger |
|---|---|
| Registrierung neuer Entwickler |
Der Entwickler hat sich für ein Konto registriert. |
| Der 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 Finanzdaten |
Der Entwickler hat Finanzdaten 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 entsprechende Kontrollkästchen aktivieren bzw. deaktivieren.
- 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 gespeichert wurden.
Benachrichtigungen mithilfe von Vorlagen mithilfe der API einrichten
Richten Sie Benachrichtigungen mithilfe der API ein, wie in den folgenden Abschnitten beschrieben.
Benachrichtigungsvorlagen mit 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 Benachrichtigungsvorlagen der Monetarisierung auflisten, 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
Das folgende Beispiel zeigt 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 ansehen
Sie können eine Benachrichtigungsvorlage ansehen, 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 folgende 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 Benachrichtigung der Vorlage würde wie folgt lauten:
"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
Senden Sie eine PUT-Anfrage an /nint/organizations/{org_name}/notification-email-templates/{template_id}, um eine Benachrichtigungsvorlage zu bearbeiten.
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 Variable 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 mithilfe der API verwalten
Verwalten Sie Benachrichtigungsbedingungen und -aktionen mithilfe der API, wie in den folgenden Abschnitten beschrieben.
- Benachrichtigungsbedingung und Aktion mithilfe der API erstellen
- Benachrichtigungsbedingung und Aktion mithilfe der API ansehen
- Benachrichtigungsbedingung und Aktion mit der API bearbeiten
- Benachrichtigungsbedingung und Aktion mit der API löschen
Benachrichtigungsbedingung und Aktion mit 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, sowie die Aktionen, die beim Erreichen der Bedingung ausgeführt werden sollen, z. B. das Senden einer Benachrichtigungs-E-Mail.
Sie definieren die Details der Benachrichtigungsbedingung, indem Sie einen oder mehrere Attributwerte angeben. 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.
Verwende beim Definieren von actions die entsprechende Benachrichtigungsvorlage. Eine Liste der Aktionen finden Sie unter Konfigurationseigenschaften für Benachrichtigungsaktionen.
Die folgende Anfrage gibt beispielsweise an, dass, wenn das Attribut NEW_PRODUCT ist und der Wert des Attributs PUBLISHED den Wert true hat, die Benachrichtigung in der Vorlage mit der ID 01191bf9-5fdd-45bf-8130-3f024694e63 (dies ist die DEFAULT_NEW_PRODUCT_TEMPLATE) gesendet wird.
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 mit der API ansehen
Rufen Sie eine Benachrichtigungsbedingung und eine Aktion auf, indem Sie eine GET-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. 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. Wenn Sie die Anfrage senden, geben Sie im Anfragetext die Änderungen an, die Sie an der 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 mithilfe der API löschen
Löschen Sie eine Benachrichtigungsbedingung, indem Sie eine DELETE-Anfrage an organizations/{org_name}notification-conditions/{condition_Id} senden. 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
Konfigurationsattribute 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 zu verfeinern. Folgende Werte sind möglich:
|
– | Ja |
value |
Wert des Attributs. |
– | Nein |
associatedCondition |
Verweis auf eine verknüpfte Bedingung. |
– | Nein |
Konfigurationsattribute für Benachrichtigungsaktionen
Die folgenden Konfigurationsattribute sind für Benachrichtigungsaktionen bei Verwendung der API verfügbar.
| Name | Beschreibung | Standard | Erforderlich? |
|---|---|---|---|
actionAttribute |
Methode zur Identifizierung des Empfängers der Benachrichtigung. Folgende Werte sind möglich:
|
– | 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 der Spring Expression Language (SpEL) eine oder mehrere Variablen einbeziehen, um die im Transaktionsobjekt zurückgegebenen Werte darzustellen.
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 in einem Antrag enthaltenen Produkts. |
${BALANCE} |
Guthaben für ein bestimmtes Kontingent. |
${developer.legalName} |
Name des Unternehmens des 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 Limits, der aufgrund der aktuellen Nutzung erreicht wurde, ohne %-Symbol. Beispiel: 50 |
${PERCENT} |
Prozentsatz eines durch die aktuelle Nutzung erreichten Limits mit %-Symbol. Beispiel: 50%. |
${products.displayName} |
Für ein Produkt definierter Anzeigename. |
${QUOTA_TYPE} |
Art der Grenze (Transaktionsvolumen, Ausgabengrenze oder Gebührenpräsenz). |
${QUOTA_UNIT} |
Basiseinheit für ein Limit: Währung (für eine Ausgabengrenze) oder Aufrufe (für ein Transaktionslimit). |
${QUOTA_LIMIT} |
Die Höhe eines Limits. |
${ratePlan.displayName} |
Anzeigename, der für einen Preisplan definiert ist. |
${ratePlan.endDate} |
Datum, an dem ein API-Anbieter einen Tarifplan 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, Kosten oder Volumen). |
${USER} |
Name eines Nutzers. |
Antwort-E-Mail-Adresse anpassen
Für die 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.