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 "genannt) S3") 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.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um eine erfolgreiche Verbindung zu einer S3 Speicher mithilfe der Flow Service API.

Sammeln erforderlicher Anmeldeinformationen

Zur Flow Service , um eine Verbindung mit Ihrer S3 -Speicher verwenden, 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, mit dem eine Verbindung hergestellt werden soll. Dieses Feld ist erforderlich, wenn Ihre S3 -Behälter ist regionsspezifisch. Das Format für serviceUrl ist: https://s3.{REGION}.amazonaws.com/).
bucketName Die S3 enthält Ihre Daten und die zugehörigen beschreibenden Metadaten. Ihre S3 Der Behältername muss zwischen drei und 63 Zeichen lang sein und entweder mit einem Buchstaben oder einer Zahl beginnen und enden. Der Behältername darf nur Kleinbuchstaben, Zahlen oder Bindestriche (-) und kann nicht als IP-Adresse formatiert werden.
folderPath Der Pfad zum Ordner in Ihrem S3 Behälter, in dem Ihre Daten gespeichert sind. Diese Berechtigung ist 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 Umgebungen. Weitere Informationen finden Sie in der S3 Übersicht.
connectionSpec.id Die Verbindungsspezifikation gibt die Connector-Eigenschaften einer Quelle zurück, einschließlich der Authentifizierungsspezifikationen für die Erstellung der Basis- und Quellverbindungen. Die Verbindungsspezifikations-ID für S3 ist: ecadc60c-7455-4d87-84dc-2a0e293d997b.

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

Verwenden von Platform-APIs

Informationen zum Aufrufen von Platform-APIs finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.

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.

Um eine Basisverbindungs-ID zu erstellen, stellen Sie eine POST-Anfrage an den Endpunkt /connections und geben Sie dabei Ihre S3-Authentifizierungsdaten als Teil der Anfrageparameter an.

API-Format

POST /connections

Anfrage

Die folgende Anfrage 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: {ORG_ID}' \
    -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 Zugriffsschlüssel, der mit Ihrer S3 Eimer.
auth.params.s3SecretKey Ihr geheimer Schlüssel, der mit Ihrem S3 Eimer.
auth.params.s3SessionToken (Optional) Kurzfristige, befristete S3 Token, mit dem auf Ihren Bucket zugegriffen 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 Ihren Speicher im nächsten Tutorial zu untersuchen.

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

Nächste Schritte

In diesem Tutorial 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 Erkunden von Cloud-Speichern mithilfe der Flow Service-API.

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 bei Ablauf aktualisiert werden. Sie können das mit Ihrer Basisverbindung verknüpfte Sitzungstoken aktualisieren, indem Sie eine PATCH-Anfrage an Flow Service API. Siehe S3 Übersicht Weitere Informationen zu temporären Sicherheitsberechtigungen für S3.

WICHTIG

Die Kopfzeile If-Match 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 Anfrage 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: {ORG_ID}' \
    -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. Die 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

Bei einer erfolgreichen Antwort werden Ihre Basisverbindungs-ID und ein aktualisiertes E-Tag angegeben. Sie können die Aktualisierung überprüfen, indem Sie eine GET-Anfrage an die Flow Service-API stellen und dabei Ihre Verbindungs-ID angeben.

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

Auf dieser Seite