Erstellen Sie eine Amazon S3-Basisverbindung mit 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 Amazon S3 (nachstehend "nachstehend "nachstehend" genanntS3") unter Verwendung 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 Erfassung von Daten aus verschiedenen Quellen und bietet Ihnen gleichzeitig die Möglichkeit, eingehende Daten zu strukturieren, zu kennzeichnen und zu verbessern, indem Sie Platform Dienstleistungen.
  • 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.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um erfolgreich eine Verbindung zu einer S3 Datenspeicherung mit Flow Service API.

Erforderliche Anmeldedaten sammeln

In der Reihenfolge Flow Service zur Verbindung mit S3 Datenspeicherung, müssen Sie Werte für die folgenden Verbindungseigenschaften angeben:

Anmeldedaten Beschreibung
s3AccessKey Die Zugriffsschlüssel-ID für Ihre S3 Eimer.
s3SecretKey Die geheime Schlüssel-ID für Ihre S3 Eimer.
serviceUrl (Optional) Die benutzerdefinierte S3 Endpunkt für die Verbindung. Dieses Feld ist erforderlich, wenn Ihr S3 Behälter ist regionsspezifisch. Das Format für serviceUrl ist: https://s3.{REGION}.amazonaws.com/).
bucketName Die S3 -Behälter enthält Ihre Daten und die zugehörigen beschreibenden Metadaten. Ihre S3 Der Behälter muss zwischen drei und 63 Zeichen lang sein und mit einem Buchstaben oder einer Zahl beginnen und enden. Der Behälter darf nur Kleinbuchstaben, Zahlen oder Bindestriche (-) und kann nicht als IP-Adresse formatiert werden.
folderPath Der Pfad zum Ordner in Ihrer S3 Behälter, in dem Ihre Daten gespeichert werden. Diese Anmeldedaten sind erforderlich, wenn der Benutzer eingeschränkten Zugriff hat.
s3SessionToken (Optional) Ein kurzfristiges, temporäres Token, mit dem Sie temporären Zugriff auf Ihre S3 Ressourcen für Benutzer in nicht vertrauenswürdigen Umgebung. Weitere Informationen finden Sie in der S3 Übersicht über.
connectionSpec.id Die Verbindungsspezifikation gibt die Verbindungseigenschaften einer Quelle zurück, einschließlich der Authentifizierungsspezifikationen für das Erstellen der Basis- und Quellverbindungen. Verbindungsspezifikations-ID für S3 ist: ecadc60c-7455-4d87-84dc-2a0e293d997b.

Weitere Informationen zu den ersten Schritten finden Sie unter dieser Amazon Web Services Dokument.

Verwenden von Plattform-APIs

Informationen dazu, wie Sie erfolgreich Aufrufe von Plattform-APIs durchführen, finden Sie im Handbuch zu Erste Schritte mit Plattform-APIs.

Basisverbindung erstellen

Bei einer Basisverbindung werden Informationen zwischen Ihrer Quelle und Plattform gespeichert, einschließlich der Authentifizierungsinformationen Ihrer Quelle, des aktuellen Zustands der Verbindung und Ihrer eindeutigen Basis-Verbindungs-ID. Die Basis-Verbindungs-ID ermöglicht es Ihnen, Dateien von der Quelle aus zu erkunden und zu navigieren und die spezifischen Elemente zu identifizieren, die Sie aufnehmen möchten, einschließlich Informationen zu den Datentypen und Formaten.

Um eine Basis-Verbindungs-ID zu erstellen, stellen Sie eine POST an /connections Endpunkt beim Bereitstellen von S3 Authentifizierungsdaten als Teil der Anforderungsparameter.

API-Format

POST /connections

Anfrage

Die folgende Anforderung erstellt eine Basisverbindung für S3:

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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Amazon S3 base connection",
        "description": "Amazon S3 base connection with temporary session token",
        "auth": {
            "specName": "Access Key",
            "params": {
                "s3AccessKey": "{S3_ACCESS_KEY}",
                "s3SecretKey": "{S3_SECRET_KEY}",
                "s3SessionToken": "{S3_SESSION_TOKEN}
            }
        },
        "connectionSpec": {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "version": "1.0"
        }
    }'
Eigenschaft Beschreibung
auth.params.s3AccessKey Der Ihrem S3 Eimer.
auth.params.s3SecretKey Ihr geheimer Schlüssel ist Ihrem/Ihrer S3 Eimer.
auth.params.s3SessionToken (Optional) Kurzfristige, befristete S3 Token, das für den Zugriff auf Ihren Behälter verwendet wird.
connectionSpec.id Die S3 Verbindungsspezifikations-ID: ecadc60c-7455-4d87-84dc-2a0e293d997b

Antwort

Eine erfolgreiche Antwort gibt Details der neu erstellten Verbindung zurück, einschließlich ihrer eindeutigen Kennung (id). Diese ID ist erforderlich, um Ihre Datenspeicherung im nächsten Tutorial zu untersuchen.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

Nächste Schritte

Durch Befolgen dieses Tutorials haben Sie eine S3-Verbindung mithilfe von APIs erstellt und eine eindeutige ID als Teil des Antworttextes erhalten. Sie können diese Verbindungs-ID verwenden, um Cloud-Datenspeicherung mithilfe der Flow Service API erkunden.

Anhang

Im folgenden Abschnitt finden Sie weitere Informationen zur Verwendung der S3 Quelle.

Aktualisieren Sie Ihre S3 Sitzungstoken

Die s3SessionToken ist temporär und muss nach Ablauf aktualisiert werden. Sie können das mit Ihrer Basisverbindung verknüpfte Session-Token aktualisieren, indem Sie eine PATCH-Anfrage an Flow Service API. Siehe S3 Überblick für weitere Informationen über befristete Sicherheitsberechtigungen für S3.

WICHTIG

Die If-Match -Header ist bei einer PATCH-Anfrage erforderlich. Der Wert für diesen Header ist das eindeutige Tag der Verbindung, die Sie aktualisieren möchten.

API-Format

PATCH /connections

Anfrage

Die folgende Anforderung erstellt eine Basisverbindung für S3:

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/connections/4cb0c374-d3bb-4557-b139-5712880adc55' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'Content-Type: application/json' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'If-Match: "1700d77b-0000-0200-0000-5e3b41a10000"'
    -d '[
        {
            "op": "replace",
            "path": "/auth/params/s3SessionToken",
            "value": "{SESSION_TOKEN}"
        }
    ]'
Parameter Beschreibung
op Der Operationsaufruf, der für die Definition der zum Aktualisieren der Verbindung erforderlichen Aktion verwendet wird. Operationen umfassen: add, replace und remove.
path Der Pfad des zu aktualisierenden Parameters.
value Der neue Wert, mit dem Sie Ihren Parameter aktualisieren möchten.

Antwort

Eine erfolgreiche Antwort gibt Ihre Basis-Verbindungs-ID und ein aktualisiertes Tag zurück. Sie können die Aktualisierung überprüfen, indem Sie eine GET an die Flow Service API, während Sie Ihre Verbindungs-ID angeben.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

Auf dieser Seite