Crea un Amazon Connessione di base S3 utilizzando Flow Service API

Una connessione di base rappresenta la connessione autenticata tra un'origine e Adobe Experience Platform.

Questa esercitazione descrive i passaggi necessari per creare una connessione di base per Amazon S3 (in appresso denominato "S3") utilizzando Flow Service API.

Introduzione

Questa guida richiede una buona comprensione dei seguenti componenti di Adobe Experience Platform:

  • Origini: Experience Platform consente l’acquisizione di dati da varie sorgenti, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo utilizzando Platform servizi.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono un singolo Platform in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per connettersi correttamente a un S3 lo storage utilizzando Flow Service API.

Raccogli credenziali richieste

Per Flow Service per connettersi con S3 è necessario specificare i valori per le seguenti proprietà di connessione:

Credenziali Descrizione
s3AccessKey ID chiave di accesso per il tuo S3 secchio.
s3SecretKey ID chiave segreta per il tuo S3 secchio.
serviceUrl (Facoltativo) Il S3 endpoint a cui connettersi. Questo campo è obbligatorio quando il S3 il bucket è specifico per la regione. Il formato per serviceUrl è: https://s3.{REGION}.amazonaws.com/).
bucketName La S3 Il bucket contiene i dati e i metadati descrittivi corrispondenti. Le S3 il nome del bucket deve essere compreso tra tre e 63 caratteri e deve iniziare e terminare con una lettera o un numero. Il nome del bucket può contenere solo lettere minuscole, numeri o trattini (-) e non può essere formattato come indirizzo IP.
folderPath Il percorso della cartella nel S3 bucket in cui vengono archiviati i dati. Questa credenziale è necessaria quando l’utente ha accesso limitato.
s3SessionToken (Facoltativo) Un token temporaneo a breve termine che ti consente di fornire un accesso temporaneo al tuo S3 risorse per gli utenti in ambienti non attendibili. Consulta la sezione S3 panoramica per ulteriori informazioni.
connectionSpec.id La specifica di connessione restituisce le proprietà del connettore di un'origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di origine. ID della specifica di connessione per S3 è: ecadc60c-7455-4d87-84dc-2a0e293d997b.

Per ulteriori informazioni su come iniziare, visita questo Amazon Web Services documento.

Utilizzo delle API di Platform

Per informazioni su come effettuare correttamente le chiamate alle API di Platform, consulta la guida su guida introduttiva alle API di Platform.

Creare una connessione di base

Una connessione di base conserva le informazioni tra l'origine e la piattaforma, incluse le credenziali di autenticazione dell'origine, lo stato corrente della connessione e l'ID di connessione di base univoco. L’ID di connessione di base consente di esplorare e navigare tra i file di origine e di identificare gli elementi specifici da acquisire, comprese le informazioni relative ai tipi di dati e ai formati corrispondenti.

Per creare un ID di connessione di base, invia una richiesta POST al /connections l'endpoint durante la fornitura del S3 credenziali di autenticazione come parte dei parametri della richiesta.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per 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"
        }
    }'
Proprietà Descrizione
auth.params.s3AccessKey Chiave di accesso associata al S3 secchio.
auth.params.s3SecretKey La chiave segreta associata al S3 secchio.
auth.params.s3SessionToken (Facoltativo) A breve termine, temporaneo S3 token utilizzato per accedere al bucket.
connectionSpec.id La S3 ID specifica di connessione: ecadc60c-7455-4d87-84dc-2a0e293d997b

Risposta

Una risposta corretta restituisce i dettagli della nuova connessione creata, incluso il relativo identificatore univoco (id). Questo ID è necessario per esplorare l'archiviazione nell'esercitazione successiva.

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

Passaggi successivi

Seguendo questa esercitazione, hai creato una connessione S3 utilizzando le API e come parte del corpo della risposta è stato ottenuto un ID univoco. Puoi usare questo ID connessione per esplorare gli archivi cloud utilizzando l’API del servizio di flusso.

Appendice

La sezione seguente fornisce informazioni aggiuntive sull’utilizzo del S3 sorgente.

Aggiorna il tuo S3 token di sessione

La s3SessionToken è temporaneo e deve essere aggiornato alla scadenza. È possibile aggiornare il token di sessione associato alla connessione di base effettuando una richiesta PATCH a Flow Service API. Consulta la sezione S3 panoramica per ulteriori informazioni sulle credenziali di sicurezza temporanee per S3.

IMPORTANTE

La If-Match l’intestazione è necessaria quando si effettua una richiesta PATCH. Il valore di questa intestazione è il tag univoco della connessione che si desidera aggiornare.

Formato API

PATCH /connections

Richiesta

La richiesta seguente crea una connessione di base per 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}"
        }
    ]'
Parametro Descrizione
op Chiamata dell’operazione utilizzata per definire l’azione necessaria per aggiornare la connessione. Le operazioni includono: add, replacee remove.
path Percorso del parametro da aggiornare.
value Il nuovo valore con cui si desidera aggiornare il parametro.

Risposta

Una risposta corretta restituisce l'ID di connessione di base e un tag aggiornato. Puoi verificare l’aggiornamento effettuando una richiesta GET al Flow Service , fornendo al tempo stesso l'ID di connessione.

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

In questa pagina