Crear una conexión base de Amazon S3 mediante la API Flow Service

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 (denominada en adelante como "S3") mediante la Flow Service API.

Introducción

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

  • Fuentes: Experience Platform permite la ingesta de datos de varias fuentes al tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
  • Zonas protegidas: Experience Platform proporciona zonas protegidas virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

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

Recopilar credenciales necesarias

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

Credencial
Descripción
s3AccessKey
Identificador de clave de acceso para el bloque S3.
s3SecretKey
Identificador de clave secreta del bloque S3.
serviceUrl
(Opcional) Punto final S3 personalizado al que conectarse. Este campo es necesario cuando el bloque S3 es específico de la región. El formato de serviceUrl es: https://s3.{REGION}.amazonaws.com/).
bucketName
El bloque S3 contiene sus datos y sus metadatos descriptivos correspondientes. El nombre del bloque S3 debe tener entre tres y 63 caracteres, y debe comenzar y finalizar con una letra o un número. El nombre del contenedor solo puede tener letras minúsculas, números o guiones (-) y no puede tener el formato de dirección IP.
folderPath
Ruta de acceso a la carpeta del bloque S3 donde se almacenan los datos. Esta credencial es necesaria cuando el usuario tiene acceso restringido.
s3SessionToken
(Opcional) Un token temporal a corto plazo que le permite proporcionar acceso temporal a sus recursos de S3 a los usuarios de entornos que no son de confianza. Consulte la S3 descripción general para obtener más información.
connectionSpec.id
La especificación de conexión devuelve las propiedades del conector de origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. El id. de especificación de conexión para S3 es: ecadc60c-7455-4d87-84dc-2a0e293d997b.

Para obtener más información sobre cómo empezar, visite este 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 sobre 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 identificador de conexión base, realice una solicitud de POST al extremo /connections y proporcione las credenciales de autenticación S3 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"
        }
    }'
Propiedad
Descripción
auth.params.s3AccessKey
La clave de acceso asociada con su bloque de S3.
auth.params.s3SecretKey
Su clave secreta asociada a su espacio de S3.
auth.params.s3SessionToken
(Opcional) El token temporal de S3 a corto plazo que se utilizó para acceder a su espacio de.
connectionSpec.id
Id. de especificación de conexión S3: ecadc60c-7455-4d87-84dc-2a0e293d997b

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 identificador de conexión para explorar los almacenes en la nube mediante la API de Flow Service.

Apéndice

La siguiente sección proporciona información adicional sobre el uso del origen S3.

Actualizar el token de sesión S3

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 la API Flow Service. Consulte la S3 descripción general para obtener más información sobre las credenciales de seguridad temporales de S3.

IMPORTANT
Se requiere el encabezado If-Match al realizar una solicitud de PATCH. El valor de este encabezado es la etiqueta única de la conexión que desea actualizar.

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}"
        }
    ]'
Parámetro
Descripción
op
La llamada de operación utilizada para definir la acción necesaria para actualizar la conexión. Las operaciones incluyen: add, replace y remove.
path
Ruta del parámetro que se va a actualizar.
value
El nuevo valor con el que desea actualizar el parámetro.

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 la API Flow Service, al tiempo que proporciona su ID de conexión.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}
recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089