Das Quince-Release (November 2020) führte Dienstkonten ein, die die Verwendung eines dedizierten API-Benutzers und Rechten erlaubt.
Daher ist es nicht mehr möglich, über diesen Apps-Abschnitt eine neue API-App zu erstellen oder eine vorhandene zu bearbeiten. Vorhandene Apps funktionieren weiter und können immer noch angezeigt werden.
Für die Verwendung einer API fordert Selligent by Zeta, dass Sie eine Anwendung (App) erstellen, die Authentifizierungs- und geheime Schüssel für die Verbindung mit der API erzeugt.
Apps sind Teil der Registerkarte Datenintegration in der Admin-Konfiguration 
Die Apps-Übersicht zeigt alle konfigurierten Apps.
Von der Übersicht aus können Sie
- Eine vorhandene App anzeigen – durch Klicken auf den Namen einer App oder das Anzeigsymbol. Die Eigenschaften werden im rechten Schieberegler angezeigt.Es können keine Änderungen vorgenommen werden.
- Eine vorhandene App löschen – durch Klicken auf das Papierkorbsymbol.
Greifen Sie auf eine App zu, um API-Authentifizierungsschlüsseln anzuzeigen
Beim Zugriff auf die App werden die Eigenschaften in einem rechten Gleitbereich angezeigt..
Der App-Name wird angezeigt.
Ein Authentifizierungsschlüssel und geheimer Schlüssel werden angezeigt und können in der API verwendet werden.
IP-Filterung stellt sicher, dass nur Aufrufe von bestimmten IP-Adressen berücksichtigt werden. Wenn ein Anruf an die API von einer anderen IP-Adresse erfolgt, funktioniert es nicht.
Optional können Sie auch die Geschäftsbereichen filtern, die Zugriff auf diese App haben. Als Folge funktionieren API-Aufrufe nur für Geschäftsbereichen in der Liste.
Auf die API zugreifen
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 der geheimer Schlüssel eingegeben werden. Sie können jetzt die API-Methoden testen.
Hinweis: Die gesamte 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.
API-Ratenlimits
Ratenbegrenzung
Ein Ratenlimit definiert die Anzahl der Anfragen, die innerhalb eines bestimmten Zeitraums an die REST API gestellt werden können. Wenn dieses Limit während eines Zeitfensters überschritten wird, wird die Anwendung gedrosselt und API-Anfragen über dem Limit werden abgelehnt.
Drosselung ist mit dem „APP“-Setup in Selligent verknüpft und wird auf den zugehörigen API-Schlüssel angewandt.
API-Limits for Selligent REST API
Alle Selligent REST API-Anfragen unterliegen Ratenlimits. Ein API-Schlüssel darf bis zu 2500 Anfragen pro Minute über alle API-Pfade durchführen.
Hinweis: Die API-Limits 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 wie im folgenden Beispiel im Text der Antwort.
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 erlaubter Anfragen im Zeitfenster dar.
- X-RateLimit-Remaining — Stellt die Anzahl der restlichen Anfragen im aktuellen Zeitfenster (1 Minute) dar.
- X-RateLimit-Reset — Stellt die restliche Zeit im aktuellen Fenster, ausgedrückt in Sekunden, dar.
Falls die 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
