Show Menu
THEMEN×

Häufig gestellte Fragen zur Plattform und Handbuch zur Fehlerbehebung

Dieses Dokument enthält Antworten auf häufig gestellte Fragen zu Adobe Experience Platform sowie eine allgemeine Anleitung zur Fehlerbehebung für häufige Fehler, die in einer Experience Platform-API auftreten können. Hinweise zur Fehlerbehebung bei einzelnen Plattformdiensten finden Sie im Fehlerbehebungsordner unten.

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-Angebote für mehrere RESTful-APIs, die HTTP-Anforderungen für den Zugriff auf Plattformressourcen verwenden. Diese Service-APIs stellen jeweils mehrere Endpunkte offen und ermöglichen Ihnen die Ausführung von Vorgängen zur Liste (GET), Suche (GET), Bearbeitung (PUT und/oder PATCH) und zum Löschen (DELETE) von Ressourcen. Weitere Informationen zu bestimmten Endpunkten und Vorgängen, die für jeden Dienst verfügbar sind, finden Sie in der API-Referenzdokumentation zu Adobe I/O.

Wie formatiere ich eine API-Anforderung?

Die Anforderungsformate variieren je nach verwendeter Plattform-API. Die beste Methode, um zu erfahren, wie Sie Ihre API-Aufrufe strukturieren, besteht darin, die in der Dokumentation für den jeweiligen Plattformdienst, den Sie verwenden, angegebenen Beispiele zu verwenden.

Lesen von Beispiel-API-Aufrufen

Die Dokumentation für Experience Platform zeigt Beispiel-API-Aufrufe auf zwei verschiedene Arten an. Zunächst wird der Aufruf im API-Format dargestellt, wobei nur die Operation (GET, POST, PUT, PATCH, DELETE) und der verwendete Endpunkt (z. B. /global/classes ) angezeigt werden. Einige Vorlagen zeigen auch den Speicherort von Variablen an, um zu veranschaulichen, wie ein Aufruf formuliert werden sollte, z. B. GET /{VARIABLE}/classes/{ANOTHER_VARIABLE} .
Die Aufrufe werden dann als cURL-Befehle in einer Anforderung angezeigt, die die erforderlichen Kopfzeilen und den vollständigen "Basispfad"enthält, der für eine erfolgreiche Interaktion mit der API erforderlich ist. Der Basispfad sollte allen Endpunkten vorangestellt werden. Der oben genannte /global/classes Endpunkt wird beispielsweise https://platform.adobe.io/data/foundation/schemaregistry/global/classes geändert. Sie sehen das API-Format/Anforderungsmuster in der gesamten Dokumentation. Es wird erwartet, dass Sie den vollständigen Pfad verwenden, der in der Beispielanforderung angezeigt wird, wenn Sie Ihre eigenen Aufrufe an Plattform-APIs durchführen.

Beispiel-API-Anforderung

Im Folgenden finden Sie eine API-Beispielanforderung, die das Format zeigt, auf das Sie in der Dokumentation stoßen werden.
API-Format
Das API-Format zeigt den Vorgang (GET) und den verwendeten Endpunkt an. Variablen werden durch geschweifte Klammern angegeben (in diesem Fall {CONTAINER_ID} ).
GET /{CONTAINER_ID}/classes

Anfrage
In dieser Beispielanforderung werden die Variablen aus dem API-Format den tatsächlichen Werten im Anforderungspfad zugewiesen. Es werden auch alle erforderlichen Kopfzeilen angezeigt, entweder als Beispiel-Kopfzeilenwerte oder Variablen, in die vertrauliche Informationen (wie Sicherheits-Token und Zugriffs-IDs) einbezogen werden sollen.
curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort
Die Antwort zeigt, was Sie nach einem erfolgreichen Aufruf der API erwarten würden, basierend auf der gesendeten Anforderung. Gelegentlich wird die Antwort für Leerzeichen abgeschnitten, d. h., Sie sehen möglicherweise weitere Informationen oder zusätzliche Informationen zu den im Beispiel angezeigten Informationen.
{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

Weitere Informationen zu bestimmten Endpunkten in Plattform-APIs, einschließlich erforderlicher Kopfzeilen und Anforderungsgremien, finden Sie in der API-Referenzdokumentation .

Was ist meine IMS-Einrichtung?

Eine IMS-Organisation ist eine Adobe-Vertretung 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-Anforderungen als Header erforderlich. 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 ID unter Clientberechtigungen zu finden. Eine schrittweise Anleitung zum Authentifizieren in der Plattform finden Sie im Authentifizierungslehrgang .

Wo finde ich meinen API-Schlüssel?

In allen API-Anforderungen ist ein API-Schlüssel als Header erforderlich. Sie finden sie über die Adobe Developer Console . Navigieren Sie in der Konsole auf der Registerkarte " Integrationen "zum Abschnitt " Übersicht "für eine bestimmte Integration und finden Sie den Schlüssel unter " Clientberechtigungen ". Eine schrittweise Anleitung zum Authentifizieren auf der Plattform finden Sie im Authentifizierungslehrgang .

Wie bekomme ich ein Zugriffstoken?

Zugriffstoken sind im Autorisierungs-Header 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 gültig. Danach muss ein neues Token generiert werden, um die API weiter verwenden zu können. Weitere Informationen zum Generieren von Zugriffstoken finden Sie im Authentifizierungstraining .

Wie verwende ich Abfragen-Parameter?

Einige Plattform-API-Endpunkte akzeptieren Parameter zur Abfrage, um bestimmte Informationen zu suchen und die in der Antwort zurückgegebenen Ergebnisse zu filtern. An die Anforderungspfade mit einem Fragezeichen ( ? ) werden Abfragen-Parameter angehängt, gefolgt von einem oder mehreren Abfragen-Parametern unter Verwendung des Formats paramName=paramValue . Wenn Sie mehrere Parameter in einem einzelnen Aufruf kombinieren, müssen Sie ein kaufmännisches Und ( & ) verwenden, um einzelne Parameter zu trennen. Das folgende Beispiel zeigt, wie eine Anforderung, die mehrere Abfragen verwendet, in der Dokumentation dargestellt wird.
Beispiele für häufig verwendete Parameter für die Abfrage:
GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

Detaillierte Informationen darüber, welche Abfragen für einen bestimmten Dienst oder Endpunkt verfügbar sind, finden Sie in der dienstspezifischen Dokumentation.

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

Viele PATCH-Vorgänge in Plattform-APIs verwenden JSON-Zeiger -Zeichenfolgen, um anzugeben, welche JSON-Eigenschaften aktualisiert werden sollen. Diese werden normalerweise in Anforderungs-Nutzlasten im JSON Patch -Format enthalten. Detaillierte Informationen zur erforderlichen Syntax für diese Technologien finden Sie im Handbuch zu den API-Grundlagen.

Kann ich Postman verwenden, um Aufrufe an Plattform-APIs zu tätigen?

Postman ist ein nützliches Werkzeug zur Visualisierung von Aufrufen an RESTful-APIs. In diesem Beitrag "Mittel"wird beschrieben, wie Sie Postman so einrichten können, dass eine Authentifizierung automatisch durchgeführt wird und damit Erlebnis-Plattform-APIs verwendet werden.

Welche Systemanforderungen gelten für Plattform?

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.
    • Bei jeder Veröffentlichung einer neuen Hauptversion werden Plattformversionen, die die neueste Beginn unterstützen, nicht mehr unterstützt, während die Unterstützung für die dritte Version eingestellt wird.
  • In allen Browsern müssen Cookies und JavaScript aktiviert sein.
Für API- und Entwicklerinteraktionen:
  • Eine Entwicklungs-Umgebung, die für REST-, Streaming- und WebHook-Integrationen entwickelt werden soll.

Fehler und Fehlerbehebung

Im Folgenden finden Sie eine Liste von Fehlern, die bei der Verwendung eines Experience Platform-Dienstes auftreten können. Hinweise zur Fehlerbehebung bei einzelnen Plattformdiensten finden Sie im Fehlerbehebungsordner unten.

API-Statuscodes

Die folgenden Statuscodes können in jeder Experience Platform-API gefunden werden. Jede hat eine Vielzahl von Ursachen, daher sind die Erklärungen in diesem Abschnitt allgemeiner Natur. Weitere Informationen zu bestimmten Fehlern in den einzelnen Plattformdiensten finden Sie im Service Troubleshooting Verzeichnis unten.
Statuscode
Beschreibung
Mögliche Ursachen
400
Ungültige Anforderung
Die Anforderung wurde falsch erstellt, fehlen wichtige Informationen und/oder enthielten eine falsche Syntax.
401
Authentifizierung fehlgeschlagen
Die Anforderung hat keine Authentifizierungsprüfung bestanden. Ihr Zugriffstoken fehlt oder ist ungültig. Weitere Informationen finden Sie im Abschnitt OAuth-Token-Fehler .
403
Verboten
Die Ressource wurde gefunden, Sie haben jedoch nicht die richtigen Anmeldeinformationen, um sie Ansicht.
404
Nicht gefunden
Die angeforderte Ressource konnte nicht auf dem Server gefunden werden. Die Ressource wurde möglicherweise gelöscht oder der angeforderte Pfad wurde falsch eingegeben.
500
Interner Server-Fehler
Dies ist ein serverseitiger Fehler. Wenn Sie viele gleichzeitige Aufrufe durchführen, erreichen Sie möglicherweise das API-Limit und müssen Ihre Ergebnisse filtern. (Weitere Informationen zum Filtern von Daten finden Sie im Handbuch für den Entwickler der Katalogdienst-API.) Warten Sie kurz, bevor Sie Ihre Anforderung erneut ausprobieren, und wenden Sie sich an Ihren Administrator, wenn das Problem weiterhin besteht.

Anforderungskopfzeilenfehler

Für alle API-Aufrufe in der Plattform sind spezifische Anforderungsheader erforderlich. Informationen dazu, welche Header für einzelne Dienste erforderlich sind, finden Sie in der API-Referenzdokumentation . Die Werte für die erforderlichen Authentifizierungsheader finden Sie im Authentifizierungslehrgang . Wenn einer dieser Header beim Durchfü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 eine Authorization Kopfzeile in einer API-Anforderung fehlt. Stellen Sie sicher, dass der Autorisierungs-Header in einem gültigen Zugriffstoken enthalten ist, bevor Sie es erneut versuchen.

OAuth-Token ist nicht gültig

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

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

API-Schlüssel erforderlich

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

Diese Fehlermeldung wird angezeigt, wenn in einer API-Anforderung ein API-Schlüsselheader ( x-api-key ) fehlt. Stellen Sie sicher, dass die Kopfzeile mit einem gültigen API-Schlüssel enthalten ist, 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üsselüberschrift ( x-api-key ) ungültig ist. Vergewissern Sie sich, dass Sie den Schlüssel korrekt eingegeben haben, bevor Sie ihn erneut versuchen. Wenn Sie Ihren API-Schlüssel nicht kennen, finden Sie ihn in der Adobe-E/A-Konsole : Navigieren Sie auf der Registerkarte Integrationen zum Abschnitt Übersicht für eine bestimmte Integration, um den API-Schlüssel unter Clientanmeldeinformationen zu suchen.

Fehlende Kopfzeile

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

Diese Fehlermeldung wird angezeigt, wenn eine IMS-Organisations-Kopfzeile ( x-gw-ims-org-id ) in einer API-Anforderung fehlt. Stellen Sie sicher, dass der Header mit der ID Ihres IMS-Unternehmens enthalten ist, bevor Sie es erneut versuchen.

Profil ist nicht gültig

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

Diese Fehlermeldung wird angezeigt, wenn der Benutzer oder die Adobe-E/A-Integration (durch das Zugriffstoken im Authorization Header identifiziert) nicht berechtigt ist, Aufrufe an Experience Platform-APIs für das im x-gw-ims-org-id Header bereitgestellte IMS-Org durchzuführen. Stellen Sie sicher, dass Sie die richtige ID für Ihr IMS-Unternehmen in der Kopfzeile angegeben haben, bevor Sie es erneut versuchen. Wenn Sie Ihre Organisations-ID nicht kennen, finden Sie sie in der Adobe I/O-Konsole : Navigieren Sie auf der Registerkarte Integrationen zum Abschnitt Übersicht für eine bestimmte Integration, um die ID unter Clientberechtigungen zu suchen.

Gültiger Inhaltstyp nicht 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-Anforderung einen ungültigen oder fehlenden Content-Type Header enthält. Stellen Sie sicher, dass der Header in der Anforderung enthalten ist und dass der Wert application/json des Headers angegeben ist.

Ordner zur Fehlerbehebung beim Dienst

Im Folgenden finden Sie eine Liste der Anleitungen zur Fehlerbehebung und der API-Referenzdokumentation für Experience Platform-APIs. Jeder Leitfaden zur Fehlerbehebung enthält Antworten auf häufig gestellte Fragen und Lösungen zu Problemen, die für einzelne Plattformdienste spezifisch sind. Die API-Referenz-Dokumente bieten eine umfassende Anleitung zu allen verfügbaren Endpunkten für jeden Dienst und zeigen Beispielanforderungsgremien, Antworten und Fehlercodes an, die Sie möglicherweise erhalten.
Service
API-Referenz
Fehlerbehebung
Zugriffskontrolle
Katalog
Datenauffüllung (Batch)
Dateneinbettung (Streaming)
Data Science-Arbeitsbereich
Datenverwendung - Kennzeichnung und Durchsetzung (DULE)
Erlebnisdatenmodell (XDM)
Identitätsdienst
Abfrage
Echtzeit-Kundenprofil
Sandboxes
Segmentierung