DokumentationExperience PlatformAnvändarhandbok om Source Connectors

Anslut Amazon S3 till Experience Platform med API:t Flow Service

Last update: Tue Feb 04 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare

Läs den här vägledningen när du vill veta hur du kan ansluta ditt Amazon S3-källkonto till Adobe Experience Platform med Flow Service API .

Kom igång

Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:

  • Källor: Med Experience Platform kan data 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 tillhandahåller virtuella sandlådor som partitionerar en enskild Platform-instans till separata virtuella miljöer för att utveckla och utveckla program för digitala upplevelser.

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.

Anslut Amazon S3 till Experience Platform på Azure azure

Läs stegen nedan om du vill ha information om hur du ansluter din Amazon S3-källa till Experience Platform på Azure.

Samla in nödvändiga inloggningsuppgifter

För att Flow Service ska kunna ansluta till ditt Amazon S3-lagringsutrymme måste du ange värden för följande anslutningsegenskaper:

Autentiseringsuppgifter
Beskrivning
s3AccessKey
Åtkomstnyckel-ID för din Amazon S3-bucket.
s3SecretKey
Det hemliga nyckel-ID:t för din Amazon S3-bucket.
serviceUrl
(Valfritt) Den anpassade Amazon S3-slutpunkten att ansluta till. Det här fältet är obligatoriskt när din Amazon S3-bucket är regionspecifik. Formatet för serviceUrl är: https://s3.{REGION}.amazonaws.com/).
bucketName
Bucket Amazon S3 innehåller dina data och dess motsvarande beskrivande metadata. Bucket-namnet Amazon S3 måste innehålla mellan 3 och 63 tecken och måste börja och sluta med en bokstav eller en siffra. Bucket-namnet får bara innehålla gemena bokstäver, siffror eller bindestreck (-) och kan inte formateras som en IP-adress.
folderPath
Sökvägen till mappen i din Amazon S3-bucket där dina data lagras. Denna autentiseringsuppgift krävs när användaren har begränsad åtkomst.
s3SessionToken
(Valfritt) En tillfällig kortvarig token som gör att du kan ge tillfällig åtkomst till dina Amazon S3-resurser till användare i miljöer som inte är betrodda. Mer information finns i Amazon S3 översikten.
connectionSpec.id
Anslutningsspecifikationen returnerar en källas kopplingsegenskaper, inklusive autentiseringsspecifikationer för att skapa bas- och källanslutningarna. Anslutningsspecifikations-ID för Amazon S3 är: ecadc60c-7455-4d87-84dc-2a0e293d997b.

Mer information om hur du kommer igång finns i det här Amazon Web Services dokumentet.

Skapa en basanslutning för Amazon S3 på Experience Platform på Azure

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 Amazon S3:

Markera för att visa ett exempel på en begäran
code language-shell 
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"
        }
    }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Egenskap Beskrivning
auth.params.s3AccessKey Åtkomstnyckeln som är associerad med din S3-bucket.
auth.params.s3SecretKey Din hemliga nyckel som är associerad med din S3-bucket.
auth.params.s3SessionToken (Valfritt) Den kortfristiga, temporära S3-token som används för att komma åt din bucket.
connectionSpec.id Anslutningsspecifikations-ID S3: 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.

Markera för att visa svarsexempel
code language-json 
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

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.

IMPORTANT
Rubriken 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 Amazon S3:

Markera för att visa ett exempel på en begäran
code language-shell 
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}"
        }
    ]'
table 0-row-2 1-row-2 2-row-2 3-row-2
Parameter Beskrivning
op Åtgärdsanropet som används för att definiera den åtgärd som krävs för att uppdatera anslutningen. Åtgärderna omfattar: add, replace och remove.
path Sökvägen till den parameter som ska uppdateras.
value Det nya värdet som du vill uppdatera parametern med.

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.

Markera för att visa svarsexempel
code language-json 
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

Anslut Amazon S3 till Experience Platform på Amazon Web Services (AWS) aws

AVAILABILITY
Detta avsnitt gäller för implementeringar av Experience Platform som körs på Amazon Web Services (AWS). Experience Platform som körs på AWS är för närvarande tillgängligt för ett begränsat antal kunder. Mer information om den Experience Platform-infrastruktur som stöds finns i Översikt över flera moln i Experience Platform.

Läs stegen nedan om du vill ha information om hur du ansluter din Amazon S3-källa till Experience Platform på AWS.

Förhandskrav

Om du vill ansluta ditt Amazon S3-konto till Experience Platform på AWS måste du ha följande:

  • Ett AWS-konto med åtkomst till den Amazon S3-bucket eller mapp som du vill ansluta.
  • Nödvändiga IAM-behörigheter som tillåter s3:GetObject- och s3:ListBucket-åtgärder.

Hämta IAM-rollen för dina bucket-behörigheter

API-format

GET /connectionSpecs/{CONNECTION_SPEC_ID}/configs?authType={AUTH_TYPE}

Begäran

Markera för att visa ett exempel på en begäran
code language-shell 
curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs/ecadc60c-7455-4d87-84dc-2a0e293d997b/configs?authType=IamBasedAuthentication' \
  -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}' \

Svar

Ett lyckat svar returnerar din IAM-roll. Det här värdet krävs i nästa steg för att konfigurera behörigheter i din Amazon S3-bucket.

Markera för att visa svarsexempel
code language-json 
{
    "configParams": {
          "IAMRole": "{IAM_ROLE}"
    }
}

Konfigurera behörigheter i din Amazon S3-bucket

  1. Logga in på ditt konto på AWS Management Console.
  2. Navigera till din Amazon S3-bucket och välj sedan Permissions.
  3. Redigera bucket-principen och lägg till följande behörigheter:
TIP
IAM_ROLE_TO_ALLOW_LIST är IAM-rollen som hämtats via API i föregående steg. Du måste ersätta {YOUR_BUCKET_NAME} med det faktiska namnet på din Amazon S3-bucket. Om du vill ge åtkomst till en viss mapp måste du även ersätta {YOUR_FOLDER_NAME} med det faktiska namnet på mappen som du vill ge åtkomst till.
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AEP Get Object Related Policy Prod",
            "Effect": "Allow",
            "Principal": {
                "AWS": "{IAM_ROLE_TO_ALLOW_LIST}"
            },
            "Action": "s3:Get*",
            "Resource": "arn:aws:s3:::{YOUR_BUCKET_NAME}/{YOUR_FOLDER_NAME}"
        },
        {
            "Sid": "AEP List Bucket Prod",
            "Effect": "Allow",
            "Principal": {
                "AWS": "{IAM_ROLE_TO_ALLOW_LIST}"
            },
            "Action": "s3:ListBucket",
            "Resource": "arn:aws:s3:::{YOUR_BUCKET_NAME}"
        }
    ]
}

Skapa en basanslutning för Amazon S3 på Experience Platform i AWS

API-format

POST /connections

Begäran

Följande begäran skapar en basanslutning för Amazon S3:

Markera för att visa exempel
code language-shell 
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 for Experience Platform on AWS",
      "description": "Amazon S3 base connection for Experience Platform on AWS",
      "auth": {
          "specName": "IAMRole Based",
          "params": {
              "bucketName": "{YOUR_BUCKET_NAME}"
          }
      },
      "connectionSpec": {
          "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2
Egenskap Beskrivning
auth.params.bucketName Namnet på din Amazon S3-bucket. Detta är samma värde som lades till i behörigheter i föregående steg.

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.

Markera för att visa exempel
code language-json 
{
    "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.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089