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 bei allen Experience Platform API. Informationen zur Fehlerbehebung bei einzelnen Platform Dienste, siehe Verzeichnis zur Fehlerbehebung bei Diensten unten.

FAQs

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

Was ist Experience Platform APIs?

Experience Platform bietet mehrere RESTful-APIs, die HTTP-Anfragen für den Zugriff verwenden Platform Ressourcen. 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 Platform API wird verwendet. Am besten erfahren Sie, wie Sie Ihre API-Aufrufe strukturieren können, indem Sie den Beispielen folgen, die in der Dokumentation für das betreffende Platform -Dienst verwenden.

Weitere Informationen zum Erstellen von API-Anfragen finden Sie im Erste-Schritte-Handbuch zur Platform-API . Beispielhafte API-Aufrufe lesen Abschnitt.

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 berechtigt ist, Experience Platform, 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: im Integrationen Registerkarte navigieren, navigieren Sie zum Übersicht für eine bestimmte Integration, um die ID unter Client-Anmeldedaten. Eine schrittweise Anleitung zum Authentifizieren in Platform, siehe 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, siehe 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 Aufrufe an Platform APIs?

Postman ist ein hilfreiches Tool zur Visualisierung von Aufrufen an RESTful-APIs. Die Erste Schritte mit der Platform-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. Die neueste Version von Chrome wird empfohlen, aktuelle und vorherige Hauptversionen von Firefox, Internet Explorer, und Safari werden ebenfalls unterstützt.
    • Jedes Mal, wenn eine neue Hauptversion veröffentlicht wird, Platform beginnt, 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 Dienst. Informationen zur Fehlerbehebung bei einzelnen Platform Dienste, siehe Verzeichnis zur Fehlerbehebung bei Diensten unten.

API-Status-Codes

Die folgenden Status-Codes können bei allen Experience Platform API. Jeder Code kann verschiedene Ursachen haben; daher sind die Erklärungen in diesem Abschnitt allgemein gehalten. Weitere Informationen zu bestimmten Fehlern im Einzelfall Platform Dienste, siehe Verzeichnis zur Fehlerbehebung bei Diensten unten.

Status-Code Beschreibung Mögliche Ursachen
400 Ungültige Anfrage Die Anfrage wurde falsch erstellt, es fehlen wichtige Informationen und/oder die Syntax ist falsch.
401 Authentifizierung fehlgeschlagen Die Anfrage hat eine Authentifizierungsprüfung nicht bestanden. Ihr Zugriffstoken fehlt oder ist ungültig. Weiterführende Informationen finden Sie im Abschnitt OAuth-Token-Fehler.
403 Verboten Die Ressource wurde zwar gefunden, Sie verfügen jedoch über nicht die richtigen Berechtigungen zur Anzeige.
404 Nicht gefunden Die angeforderte Ressource konnte auf dem Server nicht gefunden werden. Die Ressource wurde möglicherweise gelöscht oder der angefragte Pfad wurde falsch eingegeben.
500 Interner Server-Fehler Dies ist ein Server-seitiger Fehler. Wenn Sie viele simultane Aufrufe ausführen, erreichen Sie möglicherweise das API-Limit und müssen Ihre Ergebnisse filtern. (Siehe Catalog Service Unterhandbuch für API-Entwickler zu Filterdaten weitere Informationen.) Warten Sie kurz, bevor Sie Ihre Anfrage erneut testen, und wenden Sie sich an Ihren Administrator, wenn das Problem fortbesteht.

Fehler in der Anfragekopfzeile

Alle API-Aufrufe in Platform erfordert bestimmte Anfragekopfzeilen. 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 der Benutzer bzw. die Adobe I/O (durch die Variable Zugriffstoken im Authorization -Kopfzeile) nicht berechtigt ist, Aufrufe an Experience Platform APIs für die IMS-Organisation, die im Abschnitt x-gw-ims-org-id -Kopfzeile. 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 in einem der beiden folgenden Fälle angezeigt:

  • Wenn eine falsche oder falsche Kopfzeile der IMS-Organisation (x-gw-ims-org-id) wird in einer API-Anfrage übergeben. Stellen Sie sicher, dass die richtige Kennung Ihrer IMS-Organisation vorhanden ist, bevor Sie es erneut versuchen.
  • 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 Zugriffsberechtigungen generieren im Tutorial zur Platform-API-Authentifizierung , um Ihrem Konto Platform hinzuzufügen und Ihre Authentifizierungsberechtigungen 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 enthält Antworten auf häufig gestellte Fragen und Lösungen zu spezifischen Problemen Platform Dienste. 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.

Service API-Referenz Fehlerbehebung
Zugangssteuerung Zugangssteuerungs-API Handbuch zur Fehlerbehebung bei der Zugriffskontrolle
Datenerfassung in Adobe Experience Platform Data Ingestion API Handbuch zur Fehlerbehebung bei der Batch-Erfassung

Handbuch zur Fehlerbehebung bei der Streaming-Erfassung
Adobe Experience Platform Data Science Workspace Sensei Machine Learning API Data Science Workspace Handbuch zur Fehlerbehebung
Adobe Experience Platform Data Governance Policy Service API
Adobe Experience Platform Identity Service Identity Service API Identity Service Handbuch zur Fehlerbehebung
Query Service von Adobe Experience Platform Query Service API Query Service Handbuch zur Fehlerbehebung
Adobe Experience Platform-Segmentierung Segmentation API
Catalog Service Catalog Service API
Experience Data Model (XDM) Schema Registry API XDM System FAQs und Handbuch zur Fehlerbehebung
Flow Service (Sources und Destinations) Flow Service API
Real-time Customer Profile Real-time Customer Profile API Profile Handbuch zur Fehlerbehebung
Sandboxes Sandbox-API Handbuch zur Fehlerbehebung bei Sandboxes

Auf dieser Seite