Dokumentation Experience Platform Dokumentation zur Edge Network Server-API

Authentifizierung authentication

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:

Erstellt für:

Entwickler

Übersicht

Der Edge Network Server API verarbeitet sowohl authentifizierte als auch nicht authentifizierte Datenerfassung, je nach Ereignisquelle und API-Erfassungsdomäne.

Für jede Anfrage überprüft der Server API die Einstellung "datastream access type". Mit dieser Einstellung können Kunden einen Datastream so konfigurieren, dass entweder authentifizierte Daten oder sowohl authentifizierte als auch nicht authentifizierte Daten akzeptiert werden. Standardmäßig werden beide Datentypen akzeptiert.

Weitere Informationen zum Konfigurieren des Zugriffstyps auf den Datastream finden Sie in der Dokumentation zum Erstellen und Konfigurieren eines Datastreams 🔗.

Nachstehend finden Sie eine Zusammenfassung des Verhaltens, die auf der Konfiguration des Datastreams Access Type und dem Endpunkt basiert, an den die Anfrage gesendet wird.

Access Type

edge.adobedc.net

server.adobedc.net

mix (Standard)

Authentifiziert keine Anforderung

Authentifizierungsanfrage

authentifiziert

Authentifizierungsanfrage

API-Aufrufe von einem privaten Server mit server.adobedc.net sollten immer authentifiziert werden.

Voraussetzungen prerequisites

Bevor Sie Aufrufe an Server API vornehmen können, stellen Sie sicher, dass Sie die folgenden Voraussetzungen erfüllen:

Sie haben ein Organisationskonto mit Zugriff auf Adobe Experience Platform.
Für Ihr Experience Platform-Konto sind die Rollen developer und user für das Adobe Experience Platform API-Produktprofil aktiviert. Wenden Sie sich an Ihren Administrator von Admin Console , um diese Rollen für Ihr Konto zu aktivieren.
Du hast einen Adobe ID. Wenn Sie keine Adobe ID haben, wechseln Sie zum Ordner Adobe Developer Console und erstellen Sie ein neues Konto.

Sammeln von Anmeldeinformationen credentials

Um Platform-APIs aufrufen zu können, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Im Rahmen des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Kopfzeilen in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

Ressourcen in Experience Platform lassen sich in spezifischen virtuellen Sandboxes isolieren. Bei Anfragen an Platform-APIs können Sie den Namen und die Kennung der Sandbox angeben, in der der Vorgang ausgeführt werden soll. Dies sind optionale Parameter.

x-sandbox-name: {SANDBOX_NAME}

NOTE

Weitere Informationen zu Sandboxes in Experience Platform finden Sie in der Sandbox-Übersichtsdokumentation.

Bei allen Anfragen, die eine Payload enthalten (POST, PUT, PATCH), ist eine zusätzliche Medientyp-Kopfzeile erforderlich:

Content-Type: application/json

Konfigurieren von Schreibberechtigungen für Datensätze dataset-write-permissions

Um die Schreibberechtigungen für Datensätze zu konfigurieren, wechseln Sie zur Admin Console 1}, suchen Sie das Produktprofil, das an Ihren API-Schlüssel angehängt ist, und legen Sie die folgenden Berechtigungen fest:

Wählen Sie im Abschnitt Sandboxes die Sandbox des Datenspeichers aus.
Wählen Sie im Abschnitt Datenverwaltung die Berechtigung Datensätze verwalten aus.

Fehlerbehebung bei Autorisierungsfehlern troubleshooting-authorization

Fehler-Code

Fehlermeldung

Beschreibung

EXEG-0500-401

Ungültiges Autorisierungs-Token

Diese Fehlermeldung wird in den folgenden Situationen angezeigt:

Der Header-Wert authorization fehlt.
Der Header-Wert authorization enthält nicht das erforderliche Bearer -Token.
Das angegebene Autorisierungs-Token hat ein ungültiges Format.
Der Datastream erfordert Authentifizierung, aber die Anfrage fehlt an den erforderlichen Kopfzeilen.

EXEG-0501-401

Ungültiger Benutzerautorisierungs-Token

Diese Fehlermeldung wird in den folgenden Situationen angezeigt:

Dem API-Aufruf fehlt der erforderliche x-user-token -Header.
Das angegebene Benutzer-Token hat ein ungültiges Format.

EXEG-0502-401

Ungültiges Autorisierungs-Token

Diese Fehlermeldung wird angezeigt, wenn das bereitgestellte Autorisierungstoken ein gültiges Format (JWT) aufweist, die Signatur jedoch ungültig ist. Im Tutorial Authentifizierungerfahren Sie, wie Sie ein gültiges JWT-Token abrufen.

EXEG-0503-401

Ungültiges Autorisierungs-Token

Diese Fehlermeldung wird angezeigt, wenn das angegebene Autorisierungstoken abgelaufen ist. Führen Sie das Authentifizierungs-Tutorial durch, um ein neues Token zu generieren.

EXEG-0504-401

Erforderlicher Produktkontext fehlt

Diese Fehlermeldung wird in den folgenden Situationen angezeigt:

Das Entwicklerkonto hat keinen Zugriff auf den Adobe Experience Platform-Produktkontext.
Das Unternehmenskonto hat noch keinen Anspruch auf Adobe Experience Platform.

EXEG-0505-401

Erforderlicher Gültigkeitsbereich für Autorisierungs-Token fehlt

Dieser Fehler gilt nur für die Authentifizierung von Dienstkonten. Die Fehlermeldung wird angezeigt, wenn das im Aufruf enthaltene Dienstautorisierungstoken zu einem Dienstkonto gehört, das keinen Zugriff auf den IMS-Bereich acp.foundation hat.

EXEG-0506-401

Sandbox nicht zum Schreiben verfügbar

Diese Fehlermeldung wird angezeigt, wenn das Entwicklerkonto keinen WRITE -Zugriff auf die Experience Platform-Sandbox hat, in der der Datastream definiert ist.

recommendation-more-help

f36c2cef-1417-40aa-a11d-5d0abaee121b