Platform FAQs und Handbuch zur Fehlerbehebung

Dieses Dokument enthält Antworten auf häufig gestellte Fragen zu Adobe Experience Platform sowie eine allgemeine Anleitung zur Fehlerbehebung bei häufigen Fehlern, die in einer Experience Platform-API auftreten können. Eine Anleitung zur Fehlerbehebung bei einzelnen Platform-Diensten finden Sie unten im Verzeichnis zur Fehlerbehebung bei Diensten .

FAQs

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 mehrere 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?

Die Anforderungsformate variieren je nach verwendeter Platform-API. Am besten erfahren Sie, wie Sie Ihre API-Aufrufe strukturieren können, indem Sie den Beispielen in der Dokumentation für den jeweiligen Platform-Dienst folgen, den Sie verwenden.

Weitere Informationen zum Erstellen von API-Anfragen finden Sie im Erste-Schritte-Handbuch zur Platform-API Lesen Sie den Abschnitt mit Beispiel-API-Aufrufen .

Was ist meine IMS-Organisation?

Eine IMS-Organisation ist eine Adobe-Darstellung eines Kunden. Alle lizenzierten Adobe-Lösungen sind in diese Kundenorganisation integriert. Wenn eine IMS-Organisation über die Berechtigung Experience Platform verfügt, kann sie Entwicklern Zugriff zuweisen. Die IMS-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 kann über die Adobe Developer Console gefunden werden: Navigieren Sie auf der Registerkarte Integrationen zum Abschnitt Übersicht für eine bestimmte Integration, um die Kennung unter Client-Anmeldedaten zu finden. 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 finden sie über die Adobe Developer Console. 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 Zugriffstoken?

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 IMS-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, um bestimmte Informationen zu suchen und die in der Antwort zurückgegebenen Ergebnisse zu filtern. 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 Pointer-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 verwenden, um Platform-APIs aufzurufen?

Postman ist ein hilfreiches Tool zur Visualisierung von Aufrufen an RESTful-APIs. Das Erste-Schritte-Handbuch Plattform-API enthält ein Video und Anweisungen zum Importieren von Postman-Sammlungen. Darüber hinaus wird für jeden Dienst eine Liste von Postman-Kollektionen 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. Obwohl die neueste Version von Chrome empfohlen wird, werden auch aktuelle und frühere Hauptversionen von Firefox, Internet Explorer und Safari unterstützt.
  • Jedes Mal, wenn eine neue Hauptversion veröffentlicht wird, beginnt Platform, die neueste Version zu unterstützen, 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 von Fehlern, die bei der Verwendung von Experience Platform-Diensten auftreten können. Eine Anleitung zur Fehlerbehebung bei einzelnen Platform-Diensten finden Sie unten im Verzeichnis zur Fehlerbehebung bei Diensten .

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. Weitere Informationen zu spezifischen Fehlern in einzelnen Platform-Diensten finden Sie unten im Verzeichnis zur Fehlerbehebung bei Diensten .

Fehler in der Anfragekopfzeile

Für alle API-Aufrufe in Platform sind spezifische Anforderungsheader 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 Kopfzeile für die IMS-Organisation (x-gw-ims-org-id) fehlt. Stellen Sie sicher, dass die Kopfzeile die Kennung Ihrer IMS-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 Benutzer- oder Adobe I/O-Integration (identifiziert durch das Zugriffstoken in der Authorization-Kopfzeile) nicht berechtigt ist, für die IMS-Org, die in der x-gw-ims-org-id-Kopfzeile angegeben ist, Aufrufe an Experience Platform-APIs durchzuführen. Stellen Sie sicher, dass Sie in der Kopfzeile die richtige Kennung für Ihre IMS-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.

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 angezeigt, wenn Ihr Konto (wie durch die angegebenen Authentifizierungsberechtigungen dargestellt) nicht mit einem Produktprofil für die Experience Platform verknüpft ist. Führen Sie die Schritte unter Generieren von Zugriffsberechtigungen im Platform API-Authentifizierungs-Tutorial aus, um Ihrem Konto Platform hinzuzufügen und Ihre Authentifizierungsberechtigungen entsprechend zu aktualisieren.

Verzeichnis zur Fehlerbehebung bei Diensten

Im Folgenden finden Sie eine Liste von Handbüchern zur Fehlerbehebung und API-Referenzdokumentation für Experience Platform-APIs. Jedes Handbuch zur Fehlerbehebung enthält Antworten auf häufig gestellte Fragen und Lösungen zu Problemen, die für einzelne Platform-Dienste spezifisch sind. 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.