Show Menu
THEMEN×

Erstellen eines Amazon S3-Connectors mithilfe der Flow Service API

Mit dem Flow-Dienst werden Kundendaten aus verschiedenen Quellen innerhalb der Adobe Experience Platform erfasst und zentralisiert. Der Dienst stellt eine Benutzeroberfläche und eine RESTful-API bereit, über die alle unterstützten Quellen verbunden werden können.
In diesem Lernprogramm wird die Flow Service API verwendet, um Sie durch die Schritte zur Verbindung von Experience Platform mit einer Amazon S3-Datenspeicherung (im Folgenden "S3") zu führen.
Wenn Sie lieber die Benutzeroberfläche in Experience Platform verwenden möchten, finden Sie im Amazon S3-Quellschnittstellen-Lernprogramm schrittweise Anleitungen zum Ausführen ähnlicher Aktionen.

Erste Schritte

Dieses Handbuch erfordert ein Verständnis der folgenden Komponenten der Adobe Experience Platform:
  • Quellen : Mit Experience Platform können Daten aus verschiedenen Quellen erfasst werden, während Sie gleichzeitig die Möglichkeit haben, eingehende Daten mithilfe von Plattformdiensten zu strukturieren, zu beschriften und zu verbessern.
  • Sandboxen : Experience Platform bietet virtuelle Sandboxes, die eine einzelne Plattforminstanz in separate virtuelle Umgebung unterteilen, um Anwendungen für digitale Erlebnisse zu entwickeln und weiterzuentwickeln.
Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um mithilfe der Flow Service API eine Verbindung zu einer S3-Datenspeicherung herstellen zu können.

Erforderliche Berechtigungen erfassen

Damit der Flow-Dienst eine Verbindung zu Ihrer S3-Datenspeicherung herstellen kann, müssen Sie Werte für die folgenden Verbindungseigenschaften angeben:
Berechtigung
Beschreibung
s3AccessKey
Die Zugriffsschlüssel-ID für Ihre S3-Datenspeicherung.
s3SecretKey
Die geheime Schlüssel-ID für Ihre S3-Datenspeicherung.
Weitere Informationen zum Einstieg finden Sie in diesem AWS-Dokument .

Lesen von Beispiel-API-Aufrufen

In diesem Lernprogramm finden Sie Beispiele für API-Aufrufe, die zeigen, wie Sie Ihre Anforderungen formatieren. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anforderungs-Nutzdaten. Beispiel-JSON, die in API-Antworten zurückgegeben wird, wird ebenfalls bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform.

Werte für erforderliche Kopfzeilen sammeln

Um Aufrufe an Plattform-APIs durchzuführen, müssen Sie zunächst das Authentifizierungstraining abschließen. Das Abschließen des Authentifizierungstreutorials stellt die Werte für die einzelnen erforderlichen Kopfzeilen in allen Experience Platform API-Aufrufen bereit, wie unten dargestellt:
  • Genehmigung: Träger {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Alle Ressourcen in Experience Platform, einschließlich der Ressourcen des Flow-Dienstes, werden zu bestimmten virtuellen Sandboxen isoliert. Für alle Anforderungen an Plattform-APIs ist ein Header erforderlich, der den Namen der Sandbox angibt, in der der Vorgang ausgeführt wird:
  • x-sandbox-name: {SANDBOX_NAME}
Für alle Anforderungen, die eine Payload enthalten (POST, PUT, PATCH), ist ein zusätzlicher Medientyp-Header erforderlich:
  • Content-Type: application/json

Verbindungsspezifikationen nachschlagen

Bevor Sie die Plattform mit einer S3-Datenspeicherung verbinden, müssen Sie sicherstellen, dass die Verbindungsspezifikationen für S3 vorhanden sind. Wenn keine Verbindungsspezifikationen vorhanden sind, kann keine Verbindung hergestellt werden.
Jede verfügbare Quelle verfügt über einen eigenen Satz von Verbindungsspezifikationen, um Verbindungseigenschaften wie Authentifizierungsanforderungen zu beschreiben. Sie können die Verbindungsspezifikationen für S3 nachschlagen, indem Sie eine GET-Anforderung ausführen und Abfragen-Parameter verwenden.
API-Format
Beim Senden einer GET-Anforderung ohne Abfrage-Parameter werden Verbindungsspezifikationen für alle verfügbaren Quellen zurückgegeben. Sie können die Abfrage einschließen, Informationen speziell für S3 property=name=="amazon-s3" zu erhalten.
GET /connectionSpecs
GET /connectionSpecs?property=name=="amazon-s3"

Anfrage
Die folgende Anforderung ruft die Verbindungsspezifikationen für S3 ab.
curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="amazon-s3"' \
    -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
Eine erfolgreiche Antwort gibt die Verbindungsspezifikationen für S3 einschließlich der eindeutigen Kennung ( id ) zurück. Diese ID ist im nächsten Schritt erforderlich, um eine Basisverbindung zu erstellen.
{
    "items": [
        {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "name": "amazon-s3",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Access Key",
                    "type": "Access Key Auth",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to amazon-s3",
                        "properties": {
                            "s3AccessKey": {
                                "type": "string",
                                "description": "access key id"
                            },
                            "s3SecretKey": {
                                "type": "string",
                                "description": "Secret access key for the user account",
                                "format": "password"
                            }
                        },
                        "required": [
                            "accessKeyId",
                            "secretAccessKey"
                        ]
                    }
                }
            ]
        }
    ]
}

Basisverbindung erstellen

Eine Basisverbindung gibt eine Quelle an und enthält Ihre Anmeldeinformationen für diese Quelle. Pro S3-Konto ist nur eine Basisverbindung erforderlich, da diese zum Erstellen mehrerer Quell-Connectors verwendet werden kann, um verschiedene Daten einzubringen.
API-Format
POST /connections

Anfrage
curl -X POST \
    'http://platform.adobe.io/data/foundation/flowservice/connections' \
    -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}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "S3 Base Connection",
        "description": "Base connection for an Amazon S3 account",
        "auth": {
            "specName": "Access Key",
            "params": {
                "s3AccessKey": "{S3_ACCESS_KEY}",
                "s3SecretKey": "{S3_SECRET_KEY}"
            }
        },
        "connectionSpec": {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "version": "1.0"
        }
    }'

Eigenschaft
Beschreibung
auth.params.s3AccessKey
Der mit Ihrer S3-Datenspeicherung verknüpfte Zugriffsschlüssel.
auth.params.s3SecretKey
Ihr geheimer Schlüssel zu Ihrer S3-Datenspeicherung.
connectionSpec.id
Die Verbindungsspezifikation id der S3-Datenspeicherung, die im vorherigen Schritt abgerufen wurde.
Antwort
Eine erfolgreiche Antwort gibt Details zur neu erstellten Basisverbindung einschließlich ihrer eindeutigen Kennung ( id ) zurück. Diese ID ist erforderlich, um Ihre Datenspeicherung im nächsten Lernprogramm zu untersuchen.
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

Nächste Schritte

In diesem Lernprogramm haben Sie eine S3-Verbindung mit APIs erstellt und eine eindeutige ID als Teil des Antwortkörpers erhalten. Sie können diese Verbindungs-ID verwenden, um Cloud-Datenspeicherung mithilfe der Flow Service API zu untersuchen oder Parkettdaten mithilfe der Flow Service API zu erfassen .