Platform – Häufig gestellte Fragen und Handbuch zur Fehlerbehebung

Dieses Dokument enthält Antworten auf häufig gestellte Fragen zu Adobe Experience Platform sowie eine allgemeine Anleitung zur Behebung gängiger Fehler, die in Experience Platform-APIs auftreten können. Hinweise zur Fehlerbehebung bei einzelnen Platform-Services finden Sie unten im Verzeichnis zur Fehlerbehebung bei Services.

Häufig gestellte Fragen

Im Folgenden finden Sie eine Liste von Antworten auf häufig gestellte Fragen zu Adobe Experience Platform.

Was sind Experience Platform-APIs?

Experience Platform bietet verschiedene RESTful-APIs, die HTTP-Anfragen für den Zugriff auf Platform-Ressourcen verwenden. Diese Dienst-APIs machen jeweils verschiedene Endpunkte verfügbar und ermöglichen Ihnen das Auflisten (GET), Nachschlagen (GET), Bearbeiten (PUT und/oder PATCH) und Löschen (DELETE) von Ressourcen. Weiterführende Informationen zu einzelnen Endpunkten und Vorgängen, die bei den jeweiligen Diensten verfügbar sind, finden Sie in der API-Referenzdokumentation in Adobe I/O.

Wie kann ich eine API-Anfrage formatieren?

Anfrageformate variieren je nach der verwendeten Platform-API. Am einfachsten erfahren Sie, wie Sie API-Aufrufe strukturieren können, indem Sie sich die in der Dokumentation für einzelne Platform-Services angegebenen Beispiele ansehen.

Weiterführende Informationen zum Erstellen von API-Anfragen finden Sie in den Ersten Schritten für die Platform-API im Abschnitt zum Lesen beispielhafter API-Aufrufe.

Was ist meine Organisation?

Eine Organisation ist eine Adobe-Darstellung einer Kundin oder eines Kunden. Alle lizenzierten Adobe-Lösungen sind in diese Kundenorganisation integriert. Wenn eine Organisation über eine Berechtigung für Experience Platform verfügt, kann sie Entwicklerinnen und Entwicklern Zugriff zuweisen. Die Organisations-ID (x-gw-ims-org-id) stellt die Organisation dar, für die ein API-Aufruf ausgeführt werden soll, und ist daher in allen API-Anfragen als Kopfzeile obligatorisch. Diese ID können Sie unter Verwendung der Adobe Developer Console suchen: Navigieren Sie auf der Registerkarte Integrationen zum Abschnitt Übersicht einer bestimmten Integration, um unter Client-Anmeldedaten die ID anzuzeigen. Eine schrittweise Anleitung zum Authentifizieren bei Platform finden Sie im Authentifizierungs-Tutorial.

Wo finde ich meinen API-Schlüssel?

In allen API-Anfragen ist ein API-Schlüssel als Kopfzeile erforderlich. Sie können ihn über die Adobe Developer Console finden. Navigieren Sie in der Konsole auf der Registerkarte Integrationen zum Abschnitt Übersicht einer bestimmten Integration; Sie finden den Schlüssel dann unter Client-Anmeldedaten. Eine schrittweise Anleitung zum Authentifizieren bei Platform finden Sie im Authentifizierungs-Tutorial.

Woher bekomme ich ein Zugriffs-Token?

Zugriffstoken sind in der Autorisierungskopfzeile aller API-Aufrufe erforderlich. Sie können mit einem CURL-Befehl generiert werden, vorausgesetzt, Sie haben Zugriff auf eine Integration für eine Organisation. Zugriffstoken sind nur 24 Stunden lang gültig. Danach muss ein neues Token generiert werden, wenn Sie die API weiter verwenden möchten. Weiterführende Informationen zum Generieren von Zugriffstoken finden Sie im Authentifizierungs-Tutorial.

Wie verwende ich Abfrageparameter?

Einige Platform-API-Endpunkte akzeptieren Abfrageparameter, damit Sie nach bestimmten Informationen suchen und die in der Antwort zurückgegebenen Ergebnisse filtern können. Abfrageparameter werden mit einem Fragezeichen (?) an Anfragepfade angehängt, gefolgt von einem oder mehreren Abfrageparametern im Format paramName=paramValue. Wenn Sie mehrere Parameter in einem einzelnen Aufruf nutzen möchten, müssen Sie ein kaufmännisches Und-Zeichen (&) verwenden, um einzelne Parameter voneinander zu trennen. Das folgende Beispiel zeigt, wie eine Anfrage, bei der mehrere Abfrageparameter zum Einsatz kommen, in der Dokumentation dargestellt wird.

Beispiele für häufig verwendete Abfrageparameter sind:

GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

Detaillierte Informationen dazu, welche Abfragen bei einem bestimmten Service oder Endpunkt verfügbar sind, finden Sie in der dienstspezifischen Dokumentation.

Wie gebe ich ein JSON-Feld an, das in einer PATCH-Anfrage aktualisiert werden soll?

Viele PATCH-Vorgänge in Platform-APIs verwenden JSON-Zeiger-Zeichenfolgen, um anzugeben, welche JSON-Eigenschaften aktualisiert werden sollen. Diese werden normalerweise im JSON Patch-Format in Anfrage-Payloads eingebunden. Weiterführende Informationen zur für diese Technologien erforderlichen Syntax finden Sie im API-Grundlagenhandbuch.

Kann ich Postman nutzen, um Aufrufe an Platform-APIs auszuführen?

Postman ist ein hilfreiches Tool zur Visualisierung von Aufrufen an RESTful-APIs. Das Dokument Erste Schritte mit der Platform-API enthält ein Video und Anweisungen zum Importieren von Postman-Sammlungen. Darüber hinaus wird eine Liste mit Postman-Sammlungen für jeden Service bereitgestellt.

Welche Systemanforderungen gelten für Platform?

Je nachdem, ob Sie die Benutzeroberfläche oder API verwenden, gelten die folgenden Systemanforderungen:

Für UI-basierte Vorgänge:

• Ein moderner, standardmäßiger Webbrowser. Zwar wird die neueste Version von Chrome empfohlen, doch werden auch aktuelle und frühere Hauptversionen von Firefox, Internet Explorer und Safari unterstützt.
  • Bei jeder Veröffentlichung einer neuen Hauptversion beginnt Platform mit der Unterstützung der neuesten Version, während die Unterstützung für die drittneueste Version eingestellt wird.
• Bei allen Browsern müssen Cookies und JavaScript aktiviert sein.

Für Interaktionen mit APIs und Entwicklern:

• Eine Entwicklungsumgebung für die Entwicklung von REST-, Streaming- und Webhook-Integrationen.

Fehler und Fehlerbehebung

Im Folgenden finden Sie eine Liste mit Fehlern, die bei der Verwendung von Experience Platform-Services auftreten können. Hinweise zur Fehlerbehebung bei einzelnen Platform-Services finden Sie unten im Verzeichnis zur Fehlerbehebung bei Services.

API-Status-Codes

Die folgenden Status-Codes können bei jeder Experience Platform-API auftreten. Jeder Code kann verschiedene Ursachen haben; daher sind die Erklärungen in diesem Abschnitt allgemein gehalten. Weiterführende Details zu bestimmten Fehlern in einzelnen Platform-Services finden Sie unten im Verzeichnis zur Fehlerbehebung bei Services.

Fehler in der Anfragekopfzeile

Für alle Platform-Aufrufe in sind spezifische Anfragekopfzeilen erforderlich. Informationen dazu, welche Kopfzeilen für einzelne Dienste benötigt werden, finden Sie in der API-Referenzdokumentation. Die Werte für die erforderlichen Authentifizierungskopfzeilen finden Sie im Authentifizierungs-Tutorial. Wenn eine dieser Kopfzeilen beim Ausführen eines API-Aufrufs fehlt oder ungültig ist, können die folgenden Fehler auftreten.

OAuth-Token fehlt

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

Diese Fehlermeldung wird angezeigt, wenn in einer API-Anfrage eine Authorization-Kopfzeile fehlt. Stellen Sie sicher, dass die Autorisierungskopfzeile ein gültiges Zugriffstoken beinhaltet, bevor Sie es erneut versuchen.

OAuth-Token ist ungültig

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

Diese Fehlermeldung wird angezeigt, wenn das in der Authorization-Kopfzeile angegebene Zugriffstoken ungültig ist. Vergewissern Sie sich, dass Sie das Token richtig eingegeben haben, oder generieren Sie ein neues Token in der Adobe I/O-Konsole.

API-Schlüssel erforderlich

{
    "error_code": "403000",
    "message": "Api Key is required"
}

Diese Fehlermeldung wird angezeigt, wenn in einer API-Anfrage eine Kopfzeile für den API-Schlüssel (x-api-key) fehlt. Stellen Sie sicher, dass die Kopfzeile einen gültigen API-Schlüssel enthält, bevor Sie es erneut versuchen.

API-Schlüssel ist ungültig

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

Diese Fehlermeldung wird angezeigt, wenn der Wert der bereitgestellten API-Schlüsselkopfzeile (x-api-key) ungültig ist. Vergewissern Sie sich, dass Sie den Schlüssel richtig eingegeben haben, bevor Sie es erneut versuchen. Wenn Sie Ihren API-Schlüssel nicht kennen, können Sie ihn in der Adobe I/O-Konsole finden: Navigieren Sie auf der Registerkarte Integrationen zum Abschnitt Übersicht einer bestimmten Integration, um den API-Schlüssel unter Client-Anmeldedaten anzuzeigen.

Fehlende Kopfzeile

{
    "error_code": "400003",
    "message": "Missing header"
}

Diese Fehlermeldung wird angezeigt, wenn in einer API-Anfrage eine Organisationskopfzeile (x-gw-ims-org-id) fehlt. Stellen Sie sicher, dass die Kopfzeile die ID Ihrer Organisation enthält, bevor Sie es erneut versuchen.

Profil ist ungültig

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

Diese Fehlermeldung wird angezeigt, wenn die Benutzerin bzw. der Benutzer oder die Adobe I/O-Integration (identifiziert durch das Zugriffstoken in der Authorization-Kopfzeile) nicht dazu berechtigt ist, für die in der x-gw-ims-org-id-Kopfzeile angegebene Organisation Aufrufe an Experience Platform-APIs auszuführen. Stellen Sie sicher, dass Sie in der Kopfzeile die richtige ID für Ihre Organisation eingegeben haben, bevor Sie es erneut versuchen. Wenn Sie die Kennung Ihrer Organisation nicht kennen, können Sie sie in der Adobe I/O-Konsole finden: Navigieren Sie auf der Registerkarte Integrationen zum Abschnitt Übersicht einer bestimmten Integration, um die Kennung unter Client-Anmeldedaten anzuzeigen.

eTag-Fehler bei Aktualisierung

{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}

Sie erhalten möglicherweise einen eTag-Fehler, wenn eine Änderung an einer Quell- oder Zielentität wie Fluss, Verbindung, Quell-Connector oder Zielverbindung durch einen anderen API-Aufrufer vorgenommen wurde. Aufgrund der unterschiedlichen Versionen wird dann die Änderung, die Sie vornehmen möchten, nicht auf die neueste Version der Entität angewendet.

Um dies zu beheben, müssen Sie die Entität erneut abrufen, sicherstellen, dass Ihre Änderungen mit der neuen Version der Entität kompatibel sind, dann das neue eTag in der If-Match-Kopfzeile platzieren und schließlich den API-Aufruf ausführen.

Kein gültiger Inhaltstyp angegeben

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

Diese Fehlermeldung wird angezeigt, wenn eine POST-, PUT- oder PATCH-Anfrage eine ungültige oder fehlende Content-Type-Kopfzeile aufweist. Stellen Sie sicher, dass die Kopfzeile in der Anfrage enthalten ist und ihr Wert application/json lautet.

Benutzerregion fehlt

{
    "error_code": "403027",
    "message": "User region is missing"
}

Diese Fehlermeldung wird in einem der beiden folgenden Fälle angezeigt:

• Wenn eine falsche oder falsch formatierte Kopfzeile der Organisation (x-gw-ims-org-id) in einer API-Anfrage übergeben wird. Stellen Sie sicher, dass die richtige ID Ihrer Organisation vorhanden ist, bevor Sie es erneut versuchen.
• Wenn Ihr Konto (wie durch die angegebenen Authentifizierungs-Anmeldeinformationen dargestellt) nicht mit einem Produktprofil für Experience Platform verknüpft ist. Befolgen Sie im Tutorial zur Platform-API-Authentifizierung die Schritte zum Generieren von Anmeldeinformationen für den Zugriff, um Platform zu Ihrem Konto hinzuzufügen und Ihre Authentifizierungs-Anmeldeinformationen entsprechend zu aktualisieren.

Verzeichnis zur Fehlerbehebung bei Diensten

Im Folgenden finden Sie eine Liste mit Handbüchern zur Fehlerbehebung und API-Referenzdokumenten für Experience Platform-APIs. Jedes Handbuch zur Fehlerbehebung beinhaltet Antworten auf häufig gestellte Fragen und Lösungen für Probleme, die bei einzelnen Platform-Services auftreten können. API-Referenzdokumente bieten für jeden Service eine komplette Anleitung zu allen verfügbaren Endpunkten und umfassen Beispielanfragetexte, Antworten sowie Fehler-Codes, die Sie möglicherweise erhalten.