Créez une connexion de base Amazon S3 à l’aide de l’API Flow Service
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 appelée "S3") à l’aide de l’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 virtuels 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 avec succès à un stockage S3 à l’aide de l’API Flow Service.
Collecter les informations d’identification requises
Pour que Flow Service se connecte à votre stockage S3, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
s3AccessKey
s3SecretKey
serviceUrl
serviceUrl
est : https://s3.{REGION}.amazonaws.com/)
.bucketName
-
) et ne peut pas être formaté en tant qu’adresse IP.folderPath
s3SessionToken
connectionSpec.id
ecadc60c-7455-4d87-84dc-2a0e293d997b
.Pour plus d'informations sur la prise en main, consultez ce 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"
}
}'
auth.params.s3AccessKey
auth.params.s3SecretKey
auth.params.s3SessionToken
connectionSpec.id
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 source S3.
Mettre à jour votre jeton de session S3
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 à l’API Flow Service. Pour plus d’informations sur les informations d’identification de sécurité temporaires pour S3, consultez la S3 présentation .
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}"
}
]'
op
add
, replace
et remove
.path
value
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\""
}