Skapa en Amazon S3-basanslutning med API:t Flow Service
En basanslutning representerar den autentiserade anslutningen mellan en källa och Adobe Experience Platform.
I den här självstudiekursen får du hjälp med att skapa en basanslutning för Amazon S3 (kallas nedan S3) med Flow Service API.
Komma igång
Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:
- Källor: Experience Platform tillåter att data kan hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med Platform-tjänster.
- Sandlådor: Experience Platform innehåller virtuella sandlådor som partitionerar en enskild Platform-instans till separata virtuella miljöer för att hjälpa till att utveckla och utveckla program för digitala upplevelser.
I följande avsnitt finns ytterligare information som du behöver känna till för att kunna ansluta till ett S3-lagringsutrymme med API:t Flow Service.
Samla in nödvändiga inloggningsuppgifter
För att Flow Service ska kunna ansluta till ditt S3-lagringsutrymme måste du ange värden för följande anslutningsegenskaper:
s3AccessKey
s3SecretKey
serviceUrl
serviceUrl
är: https://s3.{REGION}.amazonaws.com/)
.bucketName
-
) och kan inte formateras som en IP-adress.folderPath
s3SessionToken
connectionSpec.id
ecadc60c-7455-4d87-84dc-2a0e293d997b
.Mer information om hur du kommer igång finns i det här Amazon Web Services dokumentet.
Använda plattforms-API:er
Mer information om hur du kan anropa plattforms-API:er finns i guiden Komma igång med plattforms-API:er.
Skapa en basanslutning
En basanslutning bevarar information mellan källan och plattformen, inklusive källans autentiseringsuppgifter, anslutningsstatus och ditt unika basanslutnings-ID. Med det grundläggande anslutnings-ID:t kan du utforska och navigera bland filer inifrån källan och identifiera de specifika objekt som du vill importera, inklusive information om deras datatyper och format.
Om du vill skapa ett grundläggande anslutnings-ID skickar du en POST till slutpunkten /connections
och anger dina autentiseringsuppgifter för S3 som en del av parametrarna för begäran.
API-format
POST /connections
Begäran
Följande begäran skapar en basanslutning för 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
Svar
Ett lyckat svar returnerar information om den nyligen skapade anslutningen, inklusive dess unika identifierare (id
). Detta ID krävs för att du ska kunna utforska ditt lagringsutrymme i nästa självstudiekurs.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}
Nästa steg
I den här självstudiekursen har du skapat en S3-anslutning med API:er och ett unikt ID har hämtats som en del av svarstexten. Du kan använda det här anslutnings-ID:t för att utforska molnlagring med API:t för Flow Service.
Bilaga
I följande avsnitt finns ytterligare information om hur du använder källan S3.
Uppdatera din S3-sessionstoken
s3SessionToken
är tillfällig och måste uppdateras när den upphör att gälla. Du kan uppdatera sessionstoken som är kopplad till din basanslutning genom att göra en PATCH-begäran till Flow Service API. Mer information om temporära säkerhetsuppgifter för S3 finns i S3 översikten.
If-Match
krävs när du gör en PATCH-begäran. Värdet för den här rubriken är den unika taggen för anslutningen som du vill uppdatera.API-format
PATCH /connections
Begäran
Följande begäran skapar en basanslutning för 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
och remove
.path
value
Svar
Ett lyckat svar returnerar ditt grundläggande anslutnings-ID och en uppdaterad tagg. Du kan verifiera uppdateringen genom att göra en GET-förfrågan till Flow Service-API:t och samtidigt ange ditt anslutnings-ID.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}