Créez un Amazon Connexion de base S3 à l’aide de Flow Service API

Une connexion de base représente la connexion authentifiée entre une source et Adobe Experience Platform.

Ce tutoriel vous guide tout au long des étapes pour créer une connexion de base pour Amazon S3 (ci-après dénommés "S3") en utilisant la variable Flow Service API.

Prise en main

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

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

Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour vous connecter à un S3 le stockage à l’aide de la fonction Flow Service API.

Collecter les informations d’identification requises

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

Informations d’identification Description
s3AccessKey L’identifiant de la clé d’accès pour votre S3 du compartiment.
s3SecretKey L’identifiant de clé secrète pour votre S3 du compartiment.
serviceUrl (Facultatif) La variable S3 point d’entrée auquel se connecter. Ce champ est obligatoire lorsque votre S3 est spécifique à la région. Le format de serviceUrl est : https://s3.{REGION}.amazonaws.com/).
bucketName Le S3 Le compartiment contient vos données et ses métadonnées descriptives correspondantes. Votre S3 Le nom du compartiment doit comporter entre trois et 63 caractères. Il doit commencer et se terminer par une lettre ou un nombre. Le nom du compartiment ne peut contenir que des minuscules, des chiffres ou des tirets (-) et ne peuvent pas être formatés en tant qu’adresse IP.
folderPath Chemin d’accès au dossier dans votre S3 compartiment où vos données sont stockées. Ces informations d’identification sont requises lorsque l’utilisateur dispose d’un accès restreint.
s3SessionToken (Facultatif) Jeton temporaire à court terme qui vous permet de fournir un accès temporaire à votre S3 aux utilisateurs dans des environnements non approuvés. Pour plus d’informations, consultez la S3 présentation.
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 pour S3 est ecadc60c-7455-4d87-84dc-2a0e293d997b.

Pour plus d’informations sur la prise en main, voir this Amazon Web Services document.

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

Une connexion de base conserve les informations échangées entre votre source et Platform, y compris les informations d’authentification de votre source, l’état actuel de la connexion et votre identifiant de connexion de base unique. L’identifiant de connexion de base vous permet d’explorer et de parcourir des fichiers à partir de votre source et d’identifier les éléments spécifiques que vous souhaitez 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 et indiquez vos informations d’authentification S3 dans les paramètres de la requête.

Format d’API

POST /connections

Requête

La requête suivante permet de créer une connexion de base pour 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"
        }
    }'
Propriété Description
auth.params.s3AccessKey La clé d’accès associée à votre S3 du compartiment.
auth.params.s3SecretKey Votre clé secrète associée à votre S3 du compartiment.
auth.params.s3SessionToken (Facultatif) À court terme, temporaire S3 jeton utilisé pour accéder à votre compartiment.
connectionSpec.id Le S3 identifiant de spécification de connexion : 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 stockage dans le tutoriel suivant.

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

Étapes suivantes

En suivant ce tutoriel, vous avez créé une connexion S3 à l’aide d’API et un identifiant unique a été obtenu dans le cadre du corps de la réponse. Vous pouvez utiliser cet identifiant de connexion pour explorer le stockage dans le cloud à l’aide de l’API Flow Service.

Annexe

La section suivante fournit des informations supplémentaires sur l’utilisation de la variable S3 source.

Mettez à jour votre S3 jeton de session

Le s3SessionToken est temporaire et doit être mis à jour à son expiration. Vous pouvez mettre à jour le jeton de session associé à votre connexion de base en envoyant une requête de PATCH à Flow Service API. Voir S3 aperçu pour plus d’informations sur les informations d’identification de sécurité temporaires pour S3.

IMPORTANT

L’en-tête If-Match est requis lors de l’exécution d’une requête PATCH. La valeur de cet en-tête est l’etag unique de la connexion que vous souhaitez mettre à jour.

Format d’API

PATCH /connections

Requête

La requête suivante permet de créer une connexion de base pour 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}"
        }
    ]'
Paramètre Description
op Appel d’opération utilisé pour définir l’action nécessaire pour mettre à jour la connexion. Les opérations comprennent : add, replace et remove.
path Chemin d’accès du paramètre à mettre à jour.
value Nouvelle valeur avec laquelle vous souhaitez mettre à jour votre paramètre.

Réponse

Une réponse réussie renvoie votre identifiant de connexion de base et une balise dʼentité mise à jour. Vous pouvez vérifier la mise à jour en adressant une requête GET à l’API Flow Service et en fournissant votre identifiant de connexion.

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

Sur cette page