Erstellen Sie eine Amazon Kinesis Quellverbindung mit der Flow Service-API

Dieses Tutorial führt Sie durch die Schritte zum Verbinden Amazon Kinesis (nachstehend „Kinesis“ genannt) mit Experience Platform mithilfe der Flow Service API.

Erste Schritte

Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:

  • Quellen Platform: Experience 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 Platform: Experience 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 Kinesis mithilfe der Flow Service-API erfolgreich mit Platform verbinden zu können.

Sammeln erforderlicher Anmeldeinformationen

Zur Flow Service , um eine Verbindung mit Ihrer Amazon Kinesis -Konto angeben, müssen Sie Werte für die folgenden Verbindungseigenschaften angeben:

Anmeldedaten Beschreibung
accessKeyId Die Zugriffsschlüssel-ID entspricht der Hälfte des Zugriffsschlüsselpaars, das zum Authentifizieren Ihrer Kinesis -Konto auf Platform.
secretKey Der geheime Zugriffsschlüssel ist die andere Hälfte des Zugriffsschlüsselpaars, das zum Authentifizieren Ihrer Kinesis -Konto auf Platform.
region Die Region für Ihre Kinesis -Konto. Siehe Handbuch unter Hinzufügen von IP-Adressen zu Ihrer Zulassungsliste für weitere Informationen über Regionen.
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 Spezifikations-ID der Kinesis-Verbindung lautet: 86043421-563b-46ec-8e6c-e23184711bf6.

Weitere Informationen finden Sie unter Kinesis Zugriffsschlüssel und deren Erstellung; siehe AWS Handbuch zum Verwalten von Zugriffsschlüsseln für IAM-Benutzer.

Verwenden von Platform-APIs

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

Erstellen einer Basisverbindung

Der erste Schritt beim Erstellen einer Quellverbindung besteht darin, Ihre Kinesis-Quelle zu authentifizieren und eine Basisverbindungs-ID zu generieren. Mittels einer Basisverbindungs-ID können Sie Dateien aus Ihrer Quelle durchsuchen, zwischen Dateien innerhalb der Quelle navigieren und bestimmte Elemente identifizieren, die Sie erfassen möchten, einschließlich Informationen zu Datentypen und Formaten.

Um eine Basisverbindungs-ID zu erstellen, stellen Sie eine POST-Anfrage an den /connections-Endpunkt beim Bereitstellen der Kinesis-Authentifizierungsberechtigungsdaten als Teil der Anfrageparameter.

API-Format

POST /connections

Anfrage

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 Kinesis connection",
        "description": "Connector for Amazon Kinesis",
        "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
        "auth": {
            "specName": "Aws Kinesis authentication credentials",
            "params": {
                "accessKeyId": "{ACCESS_KEY_ID}",
                "secretKey": "{SECRET_KEY}",
                "region": "{REGION}"
            }
        },
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        }
    }'
Eigenschaft Beschreibung
auth.params.accessKeyId Die Zugriffsschlüssel-ID für Ihre Kinesis -Konto.
auth.params.secretKey Der geheime Zugriffsschlüssel für Ihre Kinesis -Konto.
auth.params.region Die Region für Ihre Kinesis -Konto.
connectionSpec.id Die Kinesis Verbindungsspezifikations-ID: 86043421-563b-46ec-8e6c-e23184711bf6

Antwort

Bei einer erfolgreichen Antwort werden Details zu der neu erstellten Basisverbindung zurückgegeben, einschließlich ihrer eindeutigen Kennung (id). Diese ID ist im nächsten Schritt erforderlich, um eine Quellverbindung zu erstellen.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

Erstellen einer Quellverbindung

Eine Quellverbindung erstellt und verwaltet die Verbindung zu der externen Quelle, aus der Daten erfasst werden. Eine Quellverbindung besteht aus Informationen wie der Datenquelle, dem Datenformat und der Kennung der Quellverbindung, die zum Erstellen eines Datenflusses erforderlich ist. Eine Quellverbindungsinstanz ist für einen Mandanten und eine IMS-Organisation spezifisch.

Um eine Quellverbindung zu erstellen, stellen Sie eine POST-Anfrage an den /sourceConnections-Endpunkt der Flow Service-API.

API-Format

POST /sourceConnections

Anfrage

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -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": "AWS Kinesis source connection",
        "description": "A source connection for AWS Kinesis",
        "baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        },
        "data": {
            "format": "json"
        },
        "params": {
            "stream": "{STREAM}",
            "dataType": "raw",
            "reset": "latest"
        }
    }'
Eigenschaft Beschreibung
name Der Name Ihrer Quellverbindung. Stellen Sie sicher, dass der Name Ihrer Quellverbindung beschreibend ist, da Sie damit Informationen zu Ihrer Quellverbindung nachschlagen können.
description Ein optionaler Wert, den Sie angeben können, um weitere Informationen zu Ihrer Quellverbindung einzuschließen.
baseConnectionId Die ID der Basisverbindung Ihrer Kinesis-Quelle, die im vorhergehenden Schritt generiert wurde.
connectionSpec.id Die feste Verbindungsspezifikations-ID für Kinesis. Diese ID lautet: 86043421-563b-46ec-8e6c-e23184711bf6
data.format Das Format der Kinesis-Daten, die Sie aufnehmen möchten. Derzeit wird nur das Datenformat json unterstützt.
params.stream Der Name des Datenstreams, aus dem Datensätze abgerufen werden sollen.
params.dataType Dieser Parameter definiert den Typ der aufgenommenen Daten. Zu den unterstützten Datentypen gehören: raw und xdm.
params.reset Dieser Parameter definiert, wie die Daten gelesen werden. Verwendung latest , um mit dem Lesen der neuesten Daten zu beginnen, und verwenden Sie earliest , um mit dem Lesen der ersten verfügbaren Daten im Stream zu beginnen.

Antwort

Eine erfolgreiche Antwort gibt die eindeutige Kennung (id) der neu erstellten Quellverbindung zurück. Diese ID ist im nächsten Tutorial zum Erstellen eines Datenflusses erforderlich.

{
    "id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
    "etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}

Nächste Schritte

In diesem Tutorial haben Sie eine Kinesis-Quellverbindung mithilfe der Flow Service-API erstellt. Sie können diese Quellverbindungs-ID im nächsten Tutorial verwenden, um einen Streaming-Datenfluss mit der Flow Service -API zu erstellen.

Auf dieser Seite