Zugriffsverwaltung — Dienstkonto
Die Dienstkontenübersicht zeigt alle vorhandenen Dienstkonten in alphabetischer Reihenfolge.
Jede Zeile enthält den Namen des Dienstkontos und das letzte Änderungsdatum.
Die Übersicht kann durch Klicken auf eine Spaltenüberschrift sortiert werden.
Das Feld Suchen oben rechts ermöglicht das Suchen in der Liste der Dienstkonten auf Basis des Namens.
Von der Übersicht aus können Sie:
- Ein neues Dienstkonto erstellen – Siehe unten.
- Ein vorhandenes Dienstkonto löschen – durch Klicken auf das Papierkorbsymbol am Ende einer Zeile.
- Ein vorhandenes Dienstkonto bearbeiten – durch Klicken auf einen Namen. Die Eigenschaften werden dann im rechten Gleitbereich angezeigt.
Beim Bearbeiten eines Dienstkontos sind zwei Registerkarten sichtbar:
- Allgemein – die allgemeinen Eigenschaften des Dienstkontos
- Endpunkte – Vorgangsrechte für die verschiedenen API-Endpunkte. Diese Registerkarte ist nur für benutzerdefinierte Dienstkonten verfügbar. Für integrationsspezifische Dienstkonten (Recommendations und Site) sind die API-Endpunkte fest und können hier nicht angezeigt oder bearbeitet werden.
Ein Dienstkonto erstellen
Um ein neues Dienstkonto zu erstellen, klicken Sie auf die Schaltfläche Neu oben rechts.
Die Eigenschaften werden dann im rechten Gleitbereich angezeigt.
Geben Sie den Namen des Dienstkontos ein.
Wählen Sie die Art des Dienstkontos aus:
- Benutzerdefiniert: Zum Beispiel von der Selligent API verwendet
- Recommendations: Für die Integration zwischen Recommendations und Selligent verwendet
- Site: Für die Integration zwischen Selligent und Site verwendet Diese Informationen müssen im Konfigurationsabschnitt der Website-Sammlung hinzugefügt werden.
- Rendering: Wird beim Aktivieren der sicheren Autorisierungsanforderung in Custom Journeys verwendet. Verwenden Sie den für dieses Dienstkonto generierten Schlüssel und das Geheimnis, um den Autorisierungsheader zu erstellen. (Dies geschieht durch die Kombination des Schlüssels und des Geheimnisses mit einem Doppelpunkt und die Codierung des kombinierten Schlüssels als base64. Dies sind Ihre Anmeldeinformationen, die für die grundlegende Autorisierung verwendet werden können.)
- Loyalty: Wird für die Integration zwischen Loyalty und Selligent verwendet.
- Luzmo: Wird für die Integration mit Luzmo verwendet, dem Tool für die Erstellung und Verwaltung von Dashboard
Speichern Sie es.
Ein Authentifizierungs- und geheimer Schlüssel werden automatisch erstellt und können in der API verwendet werden.
Eine Ablaufdatum kann eingestellt werden. Der Benutzer kann aus einer Reihe vordefinierter Werte auswählen oder ein benutzerspezifisches Ablaufdatum definieren. Sobald dies erfolgt ist, wird das Ablaufdatum automatisch berechnet und hinzugefügt. Wenn das Ablaufdatum erreicht wurde oder kein Ablaufdatum eingestellt ist, wird der Benutzer informiert.
Hinweis: Wenn das Ablaufdatum erreicht ist, können der Schlüssel und der geheimer Schlüssel direkt vom Dienstkonto-Konfigurationsbereich aus verlängert werden.Klicken Sie auf Erneuern und ein neuer Schlüssel und ein neuer geheimer Schlüssel werden erstellt. Sie können auch ein neues Ablaufdatum festlegen. In diesem Fall bleiben Schlüssel und geheimer Schlüssel unverändert.
Dies bedeutet, dass ein neuer Schlüssel generiert wird und automatisch zum aktuellen Schlüssel wird. Der alte Schlüssel bleibt 2 Wochen lang gültig, um API-Funktionen für vorhandene Apps bereitzustellen, während sie mit dem neuen Schlüssel aktualisiert werden. Nach 2 Wochen wird der alte Schlüssel ungültig.
Falls erforderlich, kann IP-Filterung ebenfalls aktiviert werden. Dies stellt sicher, dass nur Aufrufe von bestimmten IP-Adressen berücksichtigt werden. Wenn ein Aufruf an die API von einer anderen IP-Adresse erfolgt, funktioniert es nicht.
Optional können Sie auch die Geschäftsbereiche filtern, die Zugriff auf dieses Dienstkonto haben. Als Folge funktionieren API-Aufrufe mithilfe dieses Dienstkontos nur für Geschäftsbereiche in der Liste. Schalten Sie die Option ein und fügen Sie die Geschäftsbereiche hinzu. Wenn die Option aktiviert ist, müssen Sie mindestens einen Geschäftsbereich auswählen.
Klicken Sie auf Speichern.
Definieren der Endpunkte (nur benutzerdefinierte Dienstkonten)
Die Registerkarte „Endpunkte“ bietet eine Übersicht über alle verfügbaren API-Endpunkte und die verschiedenen Vorgänge, die bei diesen Endpunkten erlaubt sind.
Markieren Sie die Kästchen, um die zugänglichen Endpunkte und Vorgänge für das aktuelle Dienstkonto auszuwählen.
Speichern Sie, wenn Sie fertig sind.
Hinweis: Wenn keine Endpunkte ausgewählt wurden, hat das Dienstkonto überhaupt keinen Zugriff.
Technischer Hinweis: Wenn ein Dienstkonto für die Verwendung eines Endpunkts nicht autorisiert ist, gibt die API einen HTTP-Antwortcode mit Fehlermeldung „403 – Verboten“ zurück.
Auf ein Dienstkonto zugreifen, um API-Authentifizierungsschlüssel anzuzeigen
Beim Zugriff auf ein Dienstkonto werden die Eigenschaften in einem rechten Gleitbereich angezeigt.
Der Name wird angezeigt.
Ein Authentifizierungsschlüssel und ein geheimer Schlüssel werden angezeigt und können in der API verwendet werden.
Zugreifen auf die API (nur benutzerdefinierte Dienstkonten)
Auf die API kann von einer speziellen URL aus zugegriffen werden, die mit Ihrer Umgebung verknüpft ist. (z. B. http://YOURENVIRONMENT/Portal/Api/swagger/)
Wenn der API Explorer gestartet wird, müssen oben rechts der öffentlicher Schlüssel und die geheimer Schlüssel eingegeben werden. Sie können jetzt die API-Methoden testen.
Hinweis: Die Dokumentation bezüglich der API und der Verwendung der Methoden ist direkt im API-Explorer zu finden, der über den Eintrag „Module“ in der Symbolleiste zugänglich ist.
Sie können auch über die folgende URL auf das DevPortal zugreifen, um detailliertere Informationen zur API zu erhalten: https://developers.meetmarigold.com/engage/api/ oder über den Eintrag Module in der Symbolleiste.
API-Ratenbegrenzungen
Ratenbegrenzung
Eine Ratenbegrenzung definiert die Anzahl der Anfragen, die innerhalb eines bestimmten Zeitraums an die Selligent by Zeta REST API gestellt werden können. Wenn diese Begrenzung während eines Zeitfensters überschritten wird, wird die Anwendung gedrosselt und API-Anfragen über der Grenze werden abgelehnt.
Drosselung ist mit dem „Dienstkonten“-Setup in Selligent by Zeta verknüpft und wird auf den zugehörigen API-Schlüssel angewandt.
API-Grenzen für Selligent REST API
Alle Selligent REST AP-Anfragen unterliegen Ratenbegrenzungen. Ein API-Schlüssel darf bis zu 2500 Anfragen pro Minute über alle API-Pfade durchführen.
Hinweis: Die API-Grenzen gelten nur für die Selligent REST API ; die Campaign und Direct Mail REST API unterliegen diesen Begrenzungen nicht.
Antworten, wenn Anfragen ratenbegrenzt sind
Wenn Anfragen mit einer höheren Rate durchgeführt werden als die Grenzen von:
- 2500 Anfragen/Minute
Dann erhalten diese Anfragen den HTTP-Statuscode 429 (Zu viele Anfragen) mit einer Meldung im Text der Antwort, wie im folgenden Beispiel gezeigt.
Beispiel: API-Aufrufquote überschritten! Maximal 2500 pro Minute erlaubt.
In Antwort-Headern werden zusätzliche Informationen über den Ratenbegrenzungszustand angegeben.
Beispiel:
X-RateLimit-Limit: 2500
X-RateLimit-Remaining: 50
X-RateLimit-Reset: 5
- X-RateLimit-Limit — Stellt die maximale Anzahl zulässiger Anfragen im Zeitfenster.
- X-RateLimit-Remaining — Stellt die Anzahl der verbleibenden Anfragen im aktuellen Fenster (1 Minute).
- X-RateLimit-Reset — Stellt die verbleibende Zeit in Sekunden im aktuellen Fenster.
Falls die Selligent by Zeta REST API unter hoher Last steht oder wegen Wartung ausfällt, wird der HTTP-Statuscode 503 (Service nicht verfügbar) zurückgegeben.
API-Grenze für eingehende Anfragen
An den meisten API-Endpunkten sind die Eingangs-Begrenzungen wie folgt eingestellt:
Standard-Grenze für eingehende Anfragen
- Begrenzt durch ein 15-Sekunden-Verbindungs-Timeout, was bedeutet, dass die Daten innerhalb von 15 Sekunden veröffentlicht und verarbeitet werden sollten
- Datengröße ist auf 2 MB begrenzt
- Standardrate ist auf 2500 Anfragen/Minute begrenzt
Die Endpunkte „POST /data/load“ unterstützen höhere Grenzen für eingehende Anfragen, abhängig vom Modus der Datenübertragung.
Es gibt derzeit keine Mengenvalidierungsbeschränkungen für:
- Die Anzahl der Felder pro Datensatz
- Die Gesamtzahl der zurückgegebenen Datensätze
Hinweis: Die Anzahl der Felder und die Anzahl der Datensätze ist durch die Größe des gesamten Datenobjekts begrenzt. Beispiel: Bei einer größeren Anzahl von Feldern können weniger Datensätze übermittelt werden und umgekehrt.
/data/load SYNC MODE
- Begrenzt durch ein 15-Sekunden-Verbindungs-Timeout, was bedeutet, dass die Daten innerhalb von 15 Sekunden veröffentlicht und verarbeitet werden sollten
- Die Datengröße ist auf 20 MB begrenzt
- Die Anzahl der Datenfelder ist nicht gezielt begrenzt
- Die Anzahl der Datensätze hängt von der Anzahl der Felder ab
- Die Standardrate ist auf 2500 Anfragen/Minute begrenzt
/data/load STREAMED MODE
- Keine Zeitbegrenzung für die Verbindung
- Die Daten sind auf 20 MB begrenzt
- Die Anzahl der Datenfelder ist nicht gezielt begrenzt
- Die Anzahl der Datensätze hängt von der Anzahl der Felder ab
- Die Standardrate ist auf 2500 Anfragen/Minute begrenzt
API-Grenze für ausgehende Antworten
Die Antwort-Grenze basiert normalerweise auf der Gesamt-Datenausgabe und der Zeit, die für die Abfrage des Datensatzes benötigt wird, die durch die Anzahl der definierten Felder bestimmt wird. Bei einer niedrigen Feldanzahl kann der Abruf höher sein.
Standard-Grenze für ausgehende Antworten
- Begrenzt durch ein 15-Sekunden-Verbindungs-Timeout, was bedeutet, dass die angefragten Daten innerhalb von 15 Sekunden zurückgegeben werden
- Die Standardrate ist auf 2500 Anfragen/Minute begrenzt
Die Endpunkte „POST /data/load“ unterstützen höhere Grenzen für ausgehende Antworten, abhängig vom Modus der Datenübertragung.
Es gibt derzeit keine Beschränkungen für:
- Die Anzahl der Exportfelder
- Die Anzahl der Datensätze
ABER die Kombination der Anzahl der Felder und der Anzahl der Datensätze ist durch die Größe des gesamten Datenobjekts begrenzt.
/data/search SYNC MODE
- Keine Timeout-Begrenzung
- Es wird empfohlen, die Anzahl der Datensätze auf einen „Abruf“ von „2500“ zu begrenzen
- Daten auf eine Größe von maximal 1 MB pro Datensatz begrenzt
- Standardrate begrenzt auf 2500 Anfragen/Minute
/data/search STREAMED MODE
- Keine Timeout-Begrenzung
- Daten auf eine Größe von maximal 1 MB pro Datensatz begrenzt
- Standardrate begrenzt auf 2500 Anfrage/Minute
