Benachrichtigungen konfigurieren

Online bearbeiten

Geben Sie den Absendernamen und die E-Mail-Adresse für E-Mail-Benachrichtigungen an. Bei Bedarf können Sie sich die Vorlagen in der Vorschau ansehen und den Text gegebenenfalls anpassen. Sie können die Benachrichtigungen auch an Ihr Geschäftsmotiv anpassen.

Informationen zu dieser Task

Die API Manager -E-Mails werden automatisch gesendet, wenn bestimmte Systemereignisse auftreten. Der Geltungsbereich legt fest, wie die E-Mail-Vorlagen organisiert sind, wie in Tabelle 1 erläutert.
Tabelle 1. Geltungsbereiche von Benachrichtigungen
Umfang Ereignisse, die die Benachrichtigung auslösen
Katalog Aktivitäten im Zusammenhang mit Katalogen, wie beispielsweise Ereignisse im Anwendungslebenszyklus, Einladungen zu Katalogen, Produktfreigaben und Abonnementfreigaben.
Konsument Aktivitäten im Zusammenhang mit Verbraucheranwendungen und Abonnementanfragen im Verbraucherkatalog, Einladungen zu Verbraucherorganisationen sowie Anfragen zur Passwortzurücksetzung für Konten im Verbraucherkatalog.
Anbieter Einladungen.
Bereich Einladungen.

E-Mail-Benachrichtigungen enthalten einen Absendernamen und eine Absenderadresse, die auf einer hierarchischen Suche der konfigurierten Absenderdetails in API Connectbasieren. Abhängig von der gesendeten E-Mail-Vorlage kann die Suche auf Bereichsebene beginnen und dann durch den Katalog, die Provider-Organisation und die Cloud Manager-Ebene gehen. Es werden die Absenderdaten verwendet, die bei dieser hierarchischen Suche als erste gefunden werden. Informationen dazu, welchen Suchpfad API Connect das System bei der Suche nach den Absenderangaben für die einzelnen Benachrichtigungsvorlagen verwendet, finden Sie unter „Absenderangaben für E-Mail-Benachrichtigungen konfigurieren “.

Für die Konfiguration von E-Mail-Benachrichtigungen ist eine der folgenden Rollen erforderlich:

  • Administrator
  • Eigner
  • Eine angepasste Rolle mit der Berechtigung Settings:Manage
Hinweis: Sie können Benachrichtigungen auch mithilfe der Befehlszeilenschnittstelle des Developer Toolkit oder mithilfe der API Connect -REST-APIs anpassen. Weitere Informationen finden Sie unter Befehle zur API-Entwicklung und -Verwaltung oder unter API Connect REST-APIs.

Vorgehensweise

  1. Klicken Sie im API-Manager auf Einstellungen „Einstellungen“.
  2. Klicken Sie in der Navigationsliste Einstellungen auf Benachrichtigungenund anschließend auf Bearbeiten.
  3. Geben Sie einen Absender an, indem Sie einen Namen und E-Mail-Adresseeingeben, und klicken Sie anschließend auf Speichern.
    Um Absenderdetails auf Bereichs-oder Katalogebene zu konfigurieren, müssen Sie die Befehlszeilenschnittstelle Developer Toolkit verwenden. Weitere Informationen finden Sie unter „Konfigurieren der Absenderangaben für E-Mail-Benachrichtigungen “.
  4. Optional: Um die Anpassung von Vorlagen zu aktivieren, schieben Sie den Schieberegler „Benachrichtigungsvorlagen anpassen “ in die Position „Ein “.
    Hinweis: Sie können alle vom Cloud-Administrator konfigurierten Standardbenachrichtigungen neu laden, indem Sie die Anpassung der Vorlagen deaktivieren und anschließend wieder aktivieren. Dadurch werden jedoch alle vorgenommenen Anpassungen überschrieben.
  5. Um eine Vorschau des Textes einer Vorlage anzuzeigen, wählen Sie im Optionsmenü Symbol für Auswahlmenü neben dem Namen der Vorlage die Option „Vorschau“ aus.
  6. Um den Text für die Vorlage zu bearbeiten, klicken Sie auf den Vorlagennamen oder wählen Sie Bearbeiten im Auswahlmenü neben dem Vorlagennamen aus.

    Wenn eine Vorlage geöffnet wird, wird versucht, die Sprache aus der Browsereinstellung abzurufen, aber wenn dies nicht möglich ist, wird standardmäßig Englisch verwendet.

    Der Text enthält Variablen, wie z. B. {{catalog}}. Der Benachrichtigungstext basiert auf der Handlebars-Syntax. Die meisten Variablen werden in doppelte geschweifte Klammern {{ }} eingeschlossen, können aber auch in dreifache geschweifte Klammern {{{ }}} eingeschlossen werden, um das HTML-Escaping zu deaktivieren, wenn die Variable z. B. ein URL Link ist. Weitere Informationen zu Handlebars finden Sie unter https://handlebarsjs.com/.

    Führen Sie die folgenden Schritte aus, um die vollständige Liste der Variablen zu erhalten, die für eine bestimmte Benachrichtigungsvorlage verfügbar sind:
    1. Melden Sie sich über die Befehlszeile als Mitglied einer Anbieterorganisation beim Verwaltungsserver an. Weitere Informationen finden Sie unter „Anmelden bei einem Verwaltungsserver “. Sie können im Anmeldebefehl dieselbe Verwaltungsserver- URL, denselben Benutzernamen und dasselbe Passwort verwenden, die Sie auch für die Anmeldung an der Benutzeroberfläche des API Managers verwenden.
    2. Geben Sie den folgenden Befehl ein:
      apic notification-templates:get template_name --server mgmt_endpoint_url --scope org --org provider_organization --subcollection template_scope --fields variables --output -
      Dabei gilt:
      • template_name ist der Name der erforderlichen Benachrichtigungsvorlage, die in der Spalte Vorlage in der Benutzerschnittstelle angezeigt wird.
      • template_scope ist der Bereichsname, der in der Spalte Bereich neben dieser Vorlage angezeigt wird.
      • provider_organization ist der Wert der Eigenschaft name Ihrer Providerorganisation.
      Beispiel:
      apic notification-templates:get member-invitation --server https://myserver.com --scope org --org myorg --subcollection catalog --fields variables --output -
      Die für die Vorlage verfügbaren Variablen werden angezeigt. Beispiel:
      variables:
  - org
  - catalog
  - activationLink
  - expiresAt
  - originator
  - originatorFirstName
  - originatorLastName
  - originatorEmail
  - username
  - email
  - firstName
  - lastName

      Der Parameter --output - bewirkt, dass die Befehlsausgabe in die Befehlszeile geschrieben wird. Sie können --output filepath angeben, um die Ausgabe in eine .yaml -Datei an der angegebenen Position zu schreiben, oder sie ganz weglassen, um eine Datei in den aktuellen Ordner zu schreiben.

  7. Zum Anzeigen und Bearbeiten der Benachrichtigungsvorlage in einer anderen Sprache wählen Sie eine der folgenden unterstützten Sprachen in der Dropdown-Liste Vorlage anzeigen in aus:
    • Chinesisch (vereinfacht)
    • Chinesisch (traditionell)
    • Tschechisch
    • Niederländisch
    • Englisch (amerikanisches Englisch)
    • Französisch
    • Deutsch
    • Italienisch
    • Japanisch
    • Koreanisch
    • Polnisch
    • Portugiesisch
    • Russisch
    • Spanisch
    • Türkisch
  8. Bearbeiten Sie die Datei Betreff nach Bedarf.
  9. Wählen Sie den Inhaltstyp, den Sie für die Vorlage verwenden möchten, aus HTML, PlainText oder Beides. Der Standard-Inhaltstyp ist PlainText.
    Ein Bearbeitungsfenster für den ausgewählten Inhaltstyp oder beide Bearbeitungsfenster werden angezeigt, wenn Beide ausgewählt ist.
  10. Bearbeiten Sie den Hauptteil der Vorlage nach Bedarf
    Für HTML-Inhalte sind nur die in der folgenden Tabelle aufgeführten Tags und deren Attribute zulässig.
    Tabelle 2. Zulässige HTML-Tags und -Attribute
    HTML-Tag Attribut
    <a> "class", "href", "hreflang", "style"
    <em> "class", "style"
    <strong> "class", "style"
    <cite> "class", "style"
    <blockquote> "class", "cite", "style"
    <code> "class", "style"
    <ul> "class", "type", "style"
    <ol> "class", "start", "type", "style"
    <li> "class", "style"
    <dl> "class", "style"
    <dt> "class", "style"
    <dd> "class", "style"
    <h1> "class", "id", "style"
    <h2> "class", "id", "style"
    <h3> "class", "id", "style"
    <h4> "class", "id", "style"
    <h5> "class", "id", "style"
    <h6> "class", "id", "style"
    <p> "class", "style"
    <div> "class", "style"
    <br> "class", "style"
    <span> "class", "style"
    <img> "class", "src", "alt", "data-entity-type", "data-entity-uuid", "data-align", "data-caption", "width", "height", "style"
    <table> "class", "id", "style"
    <tr> "class", "id", "style"
    <td> "class", "id", "style"
    Wenn ein nicht zulässiger HTML-Tag in einer Benachrichtigung verwendet wird, werden der Tag und sein Inhalt in der E-Mail als einfacher Text angezeigt.

    Bilder können durch Hinzufügen eines <img src="https://path/to/image.png"/> -Tags in der Vorlage verwendet werden. Das Attribut src für das Bild muss eine voll qualifizierte Webadresse URL sein und muss von außen zugänglich sein, damit die E-Mail-Empfänger auf das Bild zugreifen können. Es ist nicht möglich, auf lokale Bilder zu verweisen. Es müssen vollständige URLs sein. Es ist auch nicht möglich, Bilder oder andere Dateien in die E-Mails einzubetten oder anzuhängen.

  11. Klicken Sie anschließend auf Speichern .
    Hinweis: Bearbeitungen an einer Vorlage werden nur für die jeweilige Sprachversion gespeichert, die bearbeitet wird.