Ultimate

Créez un Amazon Kinesis Connexion source à l’aide de l’API Flow Service

Dernière mise à jour : 2023-11-14
  • Rubriques :
  • Sources
    Afficher plus sur ce sujet
  • Créé pour :
  • Developer
IMPORTANT

La variable Amazon Kinesis source est disponible dans le catalogue des sources pour les utilisateurs qui ont acheté Real-time Customer Data Platform Ultimate.

Ce tutoriel vous guide tout au long des étapes de connexion de Amazon Kinesis (ci-après dénommé « Kinesis ») à Experience Platform à l’aide de l’API Flow Service .

Prise en main

Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :

  • Sources Platform : Experience  permet d’ingérer des données provenant de diverses sources tout en vous offrant la possibilité de structurer, de libeller et d’améliorer les données entrantes à l’aide des services de Platform.
  • Sandbox Platform : Experience  fournit des sandbox virtuels qui divisent une instance de plateforme unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience digitale.

Les sections suivantes contiennent des informations supplémentaires que vous devez connaître pour réussir à connecter Kinesis à Platform à l’aide de l’API Flow Service.

Collecter les informations d’identification requises

Pour Flow Service pour vous connecter à Amazon Kinesis , vous devez fournir des valeurs pour les propriétés de connexion suivantes :

Informations d’identification Description
accessKeyId L’identifiant de clé d’accès est la moitié de la paire de clés d’accès utilisée pour authentifier votre Kinesis compte à Platform.
secretKey La clé d’accès secrète est l’autre moitié de la paire de clés d’accès utilisée pour authentifier votre Kinesis compte à Platform.
region La région de votre Kinesis compte . Consultez le guide sur la Ajout d’adresses IP à votre liste autorisée pour plus d’informations sur les régions.
connectionSpec.id La spécification de connexion renvoie les propriétés du connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions de base et source. L’identifiant de spécification de connexion Kinesis est : 86043421-563b-46ec-8e6c-e23184711bf6.

Pour plus d’informations sur Kinesis les clés d'accès et leur génération, voir à ce sujet AWS Guide de gestion des clés d’accès pour les utilisateurs IAM.

Utiliser les API Platform

Pour plus d’informations sur la manière d’effectuer avec succès des appels vers les API Platform, consultez le guide sur la Prise en main des API Platform.

Créer une connexion de base

La première étape de création d’une connexion source consiste à authentifier votre source Kinesis et à générer un identifiant de connexion de base. Un identifiant de connexion de base vous permet d’explorer et de parcourir les fichiers de votre source et d’identifier les éléments spécifiques à ingérer, y compris des informations concernant leurs types et formats de données.

Pour créer un identifiant de connexion de base, envoyez une requête POST au point d’entrée /connections lors de la fourniture des informations d’identification d’authentification Kinesis dans le cadre des paramètres de requête.

Format d’API

POST /connections

Requête

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"
        }
    }'
Propriété Description
auth.params.accessKeyId L’identifiant de la clé d’accès pour votre Kinesis compte .
auth.params.secretKey La clé d’accès secrète de votre Kinesis compte .
auth.params.region La région de votre Kinesis compte .
connectionSpec.id Identifiant de spécification de connexion Kinesis : 86043421-563b-46ec-8e6c-e23184711bf6.

Réponse

Une réponse réussie renvoie les détails de la connexion de base que vous venez de créer, y compris son identifiant unique (id). Cet identifiant est requis à l’étape suivante pour créer une connexion source.

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

Créer une connexion source

Une connexion source crée et gère la connexion à la source externe à partir de laquelle les données sont ingérées. Une connexion source se compose d’informations telles que la source de données, le format de données et l’identifiant de connexion source nécessaires pour créer un flux de données. Une instance de connexion source est spécifique à un client et à une organisation.

Pour créer une connexion source, envoyez une requête POST au point d’entrée /sourceConnections de l’API Flow Service.

Format d’API

POST /sourceConnections

Requête

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"
        }
    }'
Propriété Description
name Nom de votre connexion source. Assurez-vous que le nom de votre connexion source est descriptif, car vous pouvez l’utiliser pour rechercher des informations sur votre connexion source.
description Valeur facultative que vous pouvez fournir pour inclure plus d’informations sur votre connexion source.
baseConnectionId Identifiant de connexion de base de votre source Kinesis générée à l’étape précédente.
connectionSpec.id Identifiant de spécification de connexion fixe pour Kinesis. Cet ID est le suivant : 86043421-563b-46ec-8e6c-e23184711bf6.
data.format Format des données Kinesis que vous souhaitez ingérer. Actuellement, le format de données json est le seul à être pris en charge.
params.stream Nom du flux de données duquel extraire les enregistrements.
params.dataType Ce paramètre définit le type des données ingérées. Les types de données pris en charge sont les suivants : raw et xdm.
params.reset Ce paramètre définit la manière dont les données seront lues. Utilisation latest pour commencer la lecture à partir des données les plus récentes et utiliser earliest pour commencer la lecture à partir des premières données disponibles dans le flux.

Réponse

Une réponse réussie renvoie l’identifiant unique (id) de la nouvelle connexion source. Le tutoriel suivant requiert cet ID pour créer un flux de données.

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

Étapes suivantes

Ce tutoriel vous a permis de créer une connexion source Kinesis à l’aide de l’API Flow Service. Vous pouvez utiliser cet ID de connexion source dans le tutoriel suivant pour créer un flux de données en continu à l’aide de l’API Flow Service .

Sur cette page