Erstellen einer generischen REST-API-Basisverbindung mit der Flow Service-API
Eine Basisverbindung stellt die authentifizierte Verbindung zwischen einer Quelle und Adobe Experience Platform dar.
Dieses Tutorial führt Sie durch die Schritte zum Erstellen einer Basisverbindung für Generic REST API mithilfe der Flow Service -API.
Erste Schritte
Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:
- Quellen: Experience Platform ermöglicht die Aufnahme von Daten aus verschiedenen Quellen und bietet Ihnen die Möglichkeit, die eingehenden Daten mithilfe von Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
- Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse entwickeln und weiterentwickeln können.
Informationen darüber, wie Sie Platform-APIs erfolgreich aufrufen können, finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.
Sammeln erforderlicher Anmeldeinformationen
Damit Flow Service eine Verbindung mit Generic REST API herstellen kann, müssen Sie gültige Anmeldeinformationen für den Authentifizierungstyp Ihrer Wahl angeben. Generic REST API unterstützt sowohl OAuth 2-Aktualisierungscode als auch einfache Authentifizierung. In den folgenden Tabellen finden Sie Informationen zu den Anmeldeinformationen für die beiden unterstützten Authentifizierungstypen.
OAuth 2-Aktualisierungscode
host
requestParameterOverride
umgangen werden.authorizationTestUrl
clientId
clientSecret
accessToken
requestParameterOverride
umgangen werden.refreshToken
expirationDate
accessTokenUrl
requestParameterOverride
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
.Einfache Authentifizierung
host
username
password
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
.Erstellen einer Basisverbindung
Bei einer Basisverbindung werden Informationen zwischen Ihrer Quelle und Platform gespeichert, einschließlich der Authentifizierungsdaten Ihrer Quelle, des aktuellen Verbindungsstatus und Ihrer eindeutigen Kennung der Basisverbindung. Mit der Kennung der Basisverbindung können Sie Dateien aus Ihrer Quelle heraus analysieren und darin navigieren und die spezifischen Elemente identifizieren, die Sie erfassen möchten, einschließlich Informationen zu ihren Datentypen und Formaten.
Generic REST API unterstützt sowohl einfache Authentifizierung als auch OAuth 2-Aktualisierungs-Code. In den folgenden Beispielen finden Sie Anleitungen zum Authentifizieren mit beiden Authentifizierungstypen.
Erstellen einer Generic REST API-Basisverbindung mit OAuth 2-Aktualisierungs-Code
Um eine Basis-Verbindungs-ID mit dem OAuth 2-Aktualisierungscode zu erstellen, stellen Sie eine POST-Anfrage an den /connections
-Endpunkt und geben Sie dabei Ihre OAuth 2-Anmeldeinformationen an.
API-Format
POST /connections
Anfrage
Die folgende Anfrage erstellt eine Basisverbindung für Generic REST API:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Generic REST API base connection with OAuth 2 refresh code",
"description": "Generic REST API base connection with OAuth 2 refresh code",
"connectionSpec": {
"id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
"version": "1.0"
},
"auth": {
"specName": "oAuth2RefreshCode",
"params": {
"host": "{HOST}",
"accessToken": "{ACCESS_TOKEN}"
}
}
}'
name
description
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
.auth.specName
auth.params.host
auth.params.accessToken
Antwort
Eine erfolgreiche Antwort gibt die neu erstellte Verbindung zurück, einschließlich der eindeutigen Verbindungskennung (id
). Diese ID ist erforderlich, um Ihre Daten im nächsten Tutorial zu untersuchen.
{
"id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
"etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}
Erstellen einer Generic REST API-Basisverbindung mit einfacher Authentifizierung
Um eine Generic REST API -Basisverbindung mit einfacher Authentifizierung zu erstellen, stellen Sie eine POST-Anfrage an den /connections
-Endpunkt der Flow Service -API und geben Sie dabei Ihre grundlegenden Authentifizierungsberechtigungen an.
API-Format
POST /connections
Anfrage
Die folgende Anfrage erstellt eine Basisverbindung für Generic REST API:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"name": "Generic REST API base connection with basic authentication",
"description": "Generic REST API base connection with basic authentication",
"connectionSpec": {
"id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
"version": "1.0"
},
"auth": {
"specName": "Basic Authentication",
"params": {
"host": "{HOST}",
"username": "{USERNAME}",
"password": "{PASSWORD}"
}
}
}'
name
description
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
.auth.specName
auth.params.host
auth.params.username
auth.params.password
Antwort
Eine erfolgreiche Antwort gibt die neu erstellte Basisverbindung zurück, einschließlich ihrer eindeutigen Verbindungskennung (id
). Diese ID ist erforderlich, um die Dateistruktur und Inhalte Ihrer Quelle im nächsten Schritt zu untersuchen.
{
"id": "9601747c-6874-4c02-bb00-5732a8c43086",
"etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}
Nächste Schritte
In diesem Tutorial haben Sie eine Generic REST API-Basisverbindung mithilfe der Flow Service-API erstellt. Sie können diese Basisverbindungs-ID in den folgenden Tutorials verwenden: