Show Menu
SUJETS×

Création d’un connecteur Amazon S3 à l’aide de l’ Flow Service API

Flow Service est utilisée pour collecter et centraliser les données client provenant de diverses sources disparates au sein de l’Adobe Experience Platform. Le service fournit une interface utilisateur et une API RESTful à partir de laquelle toutes les sources prises en charge sont connectables.
Ce didacticiel utilise l' Flow Service API pour vous guider à travers les étapes de connexion Experience Platform à un Amazon enregistrement S3 (ci-après dénommé "S3").
Si vous préférez utiliser l'interface utilisateur dans Experience Platform, le didacticiel sur l'interface utilisateur du connecteur source Azure Blob ou Amazon S3 fournit des instructions détaillées pour exécuter des actions similaires.

Prise en main

Ce guide exige une compréhension pratique des éléments suivants de l'Adobe Experience Platform :
  • Sources : Experience Platform permet l’assimilation de données à partir de diverses sources tout en vous permettant de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide de Platform services.
  • Sandbox : Experience Platform fournit des sandbox virtuels qui partitionnent une Platform instance unique en environnements virtuels distincts pour aider à développer et développer des applications d'expérience numérique.
Les sections suivantes contiennent des informations supplémentaires dont vous aurez besoin pour vous connecter à un enregistrement S3 à l’aide de l’ Flow Service API.

Collecte des informations d’identification requises

Pour vous connecter Flow Service à votre enregistrement S3, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
Informations d’identification
Description
s3AccessKey
ID de clé d'accès pour votre enregistrement S3.
s3SecretKey
ID de clé secrète de votre enregistrement S3.
Pour plus d’informations sur la prise en main, consultez ce document AWS.

Lecture des exemples d’appels d’API

Ce didacticiel fournit des exemples d’appels d’API pour montrer comment formater vos requêtes. Il s’agit notamment des chemins d’accès, des en-têtes requis et des charges de requête correctement formatées. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. Pour plus d’informations sur les conventions utilisées dans la documentation pour les exemples d’appels d’API, voir la section sur la façon de lire des exemples d’appels d’API dans le guide de Experience Platform dépannage.

Rassembler les valeurs des en-têtes requis

Pour lancer des appels aux Platform API, vous devez d'abord suivre le didacticiel d' authentification. Le didacticiel d’authentification fournit les valeurs de chacun des en-têtes requis dans tous les appels d’ Experience Platform API, comme indiqué ci-dessous :
  • Autorisation : Porteur {ACCESS_TOKEN}
  • x-api-key : {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Toutes les ressources de Experience Platform, y compris celles appartenant à la Flow Service, sont isolées dans des sandbox virtuels spécifiques. Toutes les requêtes aux Platform API nécessitent un en-tête spécifiant le nom du sandbox dans lequel l'opération aura lieu :
  • x-sandbox-name : {SANDBOX_NAME}
Toutes les requêtes qui contiennent une charge utile (POST, PUT, PATCH) nécessitent un en-tête de type de support supplémentaire :
  • Content-Type : application/json

Création d’une connexion

Une connexion spécifie une source et contient vos informations d’identification pour cette source. Une seule connexion est requise par compte S3, car elle peut être utilisée pour créer plusieurs connecteurs source afin d’importer des données différentes.
Format d’API
POST /connections

Requête
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 Connection",
        "description": "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"
        }
    }'

Propriété
Description
auth.params.s3AccessKey
Clé d'accès associée à votre enregistrement S3.
auth.params.s3SecretKey
Votre clé secrète associée à votre enregistrement S3.
connectionSpec.id
ID de spécification de connexion de l'enregistrement S3 : ecadc60c-7455-4d87-84dc-2a0e293d997b
Réponse
Une réponse réussie renvoie les détails de la connexion nouvellement créée, y compris son identifiant unique ( id ). Cet identifiant est nécessaire pour explorer votre enregistrement dans le didacticiel suivant.
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

Étapes suivantes

En suivant ce didacticiel, vous avez créé une connexion S3 à l’aide d’API et un identifiant unique a été obtenu dans le corps de la réponse. Vous pouvez utiliser cet ID de connexion pour explorer les enregistrements de cloud à l’aide de l’API Flow Service ou assimiler des données de parquet à l’aide de l’API Flow Service.