Arbeiten mit der Capping-API
- Themen:
- API
Erstellt für:
- Einsteiger
- Benutzende
Mit der Capping-API können Sie Begrenzungskonfigurationen erstellen, konfigurieren und überwachen.
In diesem Abschnitt finden Sie allgemeine Informationen zur Verwendung der API. Eine detaillierte API-Beschreibung finden Sie in der Dokumentation zu Adobe Journey Optimizer-APIs.
Beschreibung des Begrenzungs-APIs und Postman-Sammlung
In der folgenden Tabelle sind die verfügbaren Befehle für das Begrenzungs-API aufgeführt. Ausführliche Informationen, einschließlich Anfragebeispielen, Parametern und Antwortformaten, finden Sie in der Dokumentation zu den Adobe Journey Optimizer-APIs.
| Methode | Pfad | Beschreibung |
|---|---|---|
| POST | list/endpointConfigs | Liste der Endpunktbegrenzungskonfigurationen abrufen |
| POST | /endpointConfigs | Endpunktbegrenzungskonfiguration erstellen |
| POST | /endpointConfigs/{uid}/deploy | Endpunktbegrenzungskonfiguration bereitstellen |
| POST | /endpointConfigs/{uid}/undeploy | Bereitstellung einer Endpunktbegrenzungskonfiguration aufheben |
| POST | /endpointConfigs/{uid}/canDeploy | Überprüfen, ob eine Endpunktbegrenzungskonfiguration bereitgestellt werden kann oder nicht |
| PUT | /endpointConfigs/{uid} | Endpunktbegrenzungskonfiguration aktualisieren |
| GET | /endpointConfigs/{uid} | Endpunktbegrenzungskonfiguration abrufen |
| DELETE | /endpointConfigs/{uid} | Endpunktbegrenzungskonfiguration löschen |
Bei der Erstellung oder Aktualisierung einer Konfiguration wird automatisch eine Überprüfung durchgeführt, um die Syntax und Integrität der Payload sicherzustellen.
Wenn Probleme auftreten, gibt der Vorgang eine Warnung oder Fehler zurück, die Ihnen beim Korrigieren der Konfiguration helfen.
Darüber hinaus steht Ihnen hier – zur Unterstützung bei Ihrer Testkonfiguration – eine Postman-Sammlung zur Verfügung.
Diese Sammlung wurde eingerichtet, um die Postman-Variablensammlung freizugeben, die über Integrationen der Adobe I/O-Konsole > Testen > Für Postman herunterladen generiert wurde. Dadurch wird eine Postman-Umgebungsdatei mit den ausgewählten Integrationswerten erzeugt.
Nach dem Herunterladen und Hochladen in Postman müssen Sie drei Variablen hinzufügen: {JO_HOST}, {BASE_PATH} und {SANDBOX_NAME}.
{JO_HOST}: Journey Optimizer-Gateway-URL.{BASE_PATH}: Einstiegspunkt für die API.{SANDBOX_NAME}: der Header x-sandbox-name (z. B. „prod“), der dem Sandbox-Namen entspricht, in dem die API-Vorgänge stattfinden. Weiterführende Informationen dazu finden Sie unter Sandbox-Übersicht.
Endpunktkonfiguration
Die grundlegende Struktur einer Endpunktkonfiguration sieht wie folgt aus:
{
"url": "<endpoint URL>", //wildcards are allowed in the endpoint URL
"methods": [ "<HTTP method such as GET, POST, >, ...],
"services": {
"<service name>": { . //must be "action" or "dataSource"
"maxHttpConnections": <max connections count to the endpoint (optional)>
"rating": {
"maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
"periodInMs": <integer value greater than 0>
}
},
...
}
}
IMPORTANTBeispiel:
`{
"url": "https://api.example.org/data/2.5/*",
"methods": [
"GET"
],
"services": {
"dataSource": {
"rating": {
"maxCallsCount": 500,
"periodInMs": 1000
}
}
}
}
Warnung und Fehler
Wenn eine canDeploy-Methode aufgerufen wird, validiert der Prozess die Konfiguration und gibt den durch seine eindeutige Kennung identifizierten Validierungsstatus zurück:
"ok" or "error"
Mögliche Fehler sind:
- ERR_ENDPOINTCONFIG_100: capping config: missing or invalid url
- ERR_ENDPOINTCONFIG_101: capping config: malformed url
- ERR_ENDPOINTCONFIG_102: capping config: malformed url: wildchar in url not allowed in host:port
- ERR_ENDPOINTCONFIG_103: capping config: missing HTTP methods
- ERR_ENDPOINTCONFIG_104: capping config: no call rating defined
- ERR_ENDPOINTCONFIG_107: capping config: invalid max calls count (maxCallsCount)
- ERR_ENDPOINTCONFIG_108: capping config: invalid max calls count (periodInMs)
- ERR_ENDPOINTCONFIG_111: capping config: can't create endpoint config: invalid payload
- ERR_ENDPOINTCONFIG_112: capping config: can't create endpoint config: expecting a JSON payload
- ERR_AUTHORING_ENDPOINTCONFIG_1: invalid service name
<!--<given value>-->: must be 'dataSource' or 'action'
Die potenzielle Warnung lautet:
ERR_ENDPOINTCONFIG_106: capping config: max HTTP connections not defined: no limitation by default
Anwendungsfälle
In diesem Abschnitt werden wichtige Anwendungsfälle für die Verwaltung von Begrenzungskonfigurationen in Journey Optimizer und die zugehörigen API-Befehle aufgelistet, die zur Implementierung des jeweiligen Anwendungsfalls erforderlich sind.
Details zu den einzelnen API-Befehlen finden Sie unter API-Beschreibung und Postman-Sammlung.
Zu verwendende API-Aufrufe:
list: Ruft vorhandene Konfigurationen ab.create: Erstellt eine neue Konfiguration.candeploy: Prüft, ob die Konfiguration bereitgestellt werden kann.deploy: Stellt die Konfiguration bereit.
Zu verwendende API-Aufrufe:
list: Ruft vorhandene Konfigurationen ab.get: Ruft Details zu einer bestimmten Konfiguration ab.update: Ändert die Konfiguration.candeploy: Prüft die Eignung der Bereitstellung.deploy: Stellt die Konfiguration bereit.
Zu verwendende API-Aufrufe:
list: Ruft vorhandene Konfigurationen ab.undeploy: Hebt die Bereitstellung der Konfiguration auf.delete: Entfernt die Konfiguration.
In nur einem API-Aufruf können Sie mithilfe des Parameters forceDelete die Bereitstellung aufheben und die Konfiguration löschen.
Zu verwendende API-Aufrufe:
list: Ruft vorhandene Konfigurationen ab.delete(mit dem ParameterforceDelete): Erzwingt die Löschung einer bereitgestellten Konfiguration in einem einzigen Schritt.
NOTEZu verwendende API-Aufrufe:
list: Ruft vorhandene Konfigurationen ab.get: Ruft Details zu einer bestimmten Konfiguration ab.update: Ändert die Konfiguration.undeploy: Hebt die Bereitstellung der Konfiguration auf, bevor Änderungen angewendet werden.candeploy: Prüft die Eignung der Bereitstellung.deploy: Stellt die aktualisierte Konfiguration bereit.