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

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

Ce tutoriel vous explique les étapes à suivre pour créer une connexion de base pour Amazon S3 (ci-après dénommés "S3") en utilisant la 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 l’assimilation de données à partir de diverses sources tout en vous permettant de structurer, étiqueter et améliorer les données entrantes à l’aide de Platform services.
  • Environnements de test : Experience Platform fournit des environnements de test virtuels qui divisent une instance Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience numérique.

Les sections suivantes fournissent des informations supplémentaires que vous devez connaître pour vous connecter à un S3 stockage à l’aide de la Flow Service API.

Collecte des 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’ID de clé d’accès pour votre S3 Pot.
s3SecretKey L’ID de clé secrète de votre S3 Pot.
serviceUrl (Facultatif) La S3 point de terminaison 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 contient vos données et les métadonnées descriptives correspondantes. Votre S3 le nom du seau doit comporter entre trois et 63 caractères et doit commencer et se terminer par une lettre ou un chiffre. Le nom du regroupement ne peut contenir que des lettres minuscules, des chiffres ou des tirets (-) et ne peut pas être formaté en tant qu’adresse IP.
folderPath Chemin d’accès au dossier dans votre S3 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 de courte durée 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 de connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions de base et source. ID de spécification de connexion pour S3 est : ecadc60c-7455-4d87-84dc-2a0e293d997b.

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

Utilisation des API de plate-forme

Pour plus d’informations sur la manière d’effectuer des appels vers les API de plate-forme, consultez le guide sur prise en main des API de plate-forme.

Création d’une connexion de base

Une connexion de base conserve les informations entre votre source et la plate-forme, y compris les informations d'identification de votre source, l'état actuel de la connexion et votre ID de connexion de base unique. L’ID de connexion de base vous permet d’explorer et de parcourir les fichiers à partir de votre source et d’identifier les éléments spécifiques que vous souhaitez assimiler, y compris des informations concernant leurs types et formats de données.

Pour créer un ID de connexion de base, effectuez une demande de POST à l’adresse /connections point de terminaison lors de la fourniture de votre S3 les informations d'identification d'authentification dans le cadre des paramètres de demande.

Format d’API

POST /connections

Requête

La demande suivante crée 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: {IMS_ORG}' \
    -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 Pot.
auth.params.s3SecretKey Votre clé secrète associée à votre S3 Pot.
auth.params.s3SessionToken (Facultatif) Le court terme, temporaire S3 jeton utilisé pour accéder à votre seau.
connectionSpec.id Le S3 ID 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 ID est nécessaire pour explorer votre espace de 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 ID unique a été obtenu dans le corps de la réponse. Vous pouvez utiliser cet ID de connexion pour exploration des sites de 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 S3 source.

Mettre à jour votre S3 jeton de session

Le s3SessionToken est temporaire et doit être mis à jour à l’expiration. Vous pouvez mettre à jour le jeton de session associé à votre connexion de base en adressant une demande de PATCH à Flow Service API. Voir la section S3 présentation pour plus d'informations sur les informations d'identification de sécurité temporaires pour S3.

IMPORTANT

Le If-Match est requis lors de la demande de PATCH. La valeur de cet en-tête correspond à l'étiquette unique de la connexion à mettre à jour.

Format d’API

PATCH /connections

Requête

La demande suivante crée 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: {IMS_ORG}' \
    -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 ID de connexion de base et une balise mise à jour. Vous pouvez vérifier la mise à jour en adressant une demande de GET à la Flow Service API, lors de la fourniture de votre ID de connexion.

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

Sur cette page