Crear un Amazon Conexión base S3 con el Flow Service API

Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.

Este tutorial lo acompañará durante los pasos para crear una conexión base para Amazon S3 (en lo sucesivo, "S3") utilizando el Flow Service API.

Primeros pasos

Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:

Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente a un S3 almacenamiento mediante el Flow Service API.

Recopilar credenciales necesarias

Para que Flow Service para conectarse con su S3 almacenamiento, debe proporcionar valores para las siguientes propiedades de conexión:

Para obtener más información sobre cómo empezar, visite esta Amazon Web Services documento.

Uso de API de Platform

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía de introducción a las API de Platform.

Crear una conexión base

Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.

Para crear un ID de conexión base, realice una solicitud de POST al /connections extremo al proporcionar su S3 credenciales de autenticación como parte de los parámetros de solicitud.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión base para 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"
        }
    }'

Respuesta

Una respuesta correcta devuelve detalles de la conexión recién creada, incluido su identificador único (id). Este ID es necesario para explorar el almacenamiento en el siguiente tutorial.

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

Pasos siguientes

Al seguir este tutorial, ha creado una conexión S3 mediante API y se ha obtenido un ID único como parte del cuerpo de respuesta. Puede usar este ID de conexión para lo siguiente explore los almacenes en la nube mediante la API de Flow Service.

Apéndice

En la siguiente sección se proporciona información adicional sobre el uso de S3 origen.

Actualice su S3 token de sesión

El s3SessionToken es temporal y debe actualizarse cuando caduque. Puede actualizar el token de sesión asociado a su conexión base realizando una solicitud de PATCH a Flow Service API. Consulte la S3 descripción general para obtener más información sobre las credenciales de seguridad temporales de S3.

Formato de API

PATCH /connections

Solicitud

La siguiente solicitud crea una conexión base para 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}"
        }
    ]'

Respuesta

Una respuesta correcta devuelve el ID de conexión base y una etiqueta actualizada. Puede comprobar la actualización realizando una solicitud de GET a Flow Service API, mientras proporciona su ID de conexión.

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