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:

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

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:

Credencial Descripción
s3AccessKey El ID de la clave de acceso de su S3 cubo.
s3SecretKey El ID de clave secreta de su S3 cubo.
serviceUrl (Opcional) El personalizado S3 punto final al que conectarse. Este campo es obligatorio cuando su S3 el bloque es específico de la región. El formato para serviceUrl es: https://s3.{REGION}.amazonaws.com/).
bucketName El S3 El bloque contiene los datos y sus metadatos descriptivos correspondientes. Su S3 el nombre del contenedor debe tener entre tres y 63 caracteres y debe comenzar y terminar con una letra o un número. El nombre del contenedor solo puede tener letras minúsculas, números o guiones (-) y no se puede formatear como una dirección IP.
folderPath La ruta a la carpeta en su S3 bloque en el que 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 su S3 recursos para usuarios en 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. Identificador 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 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"
        }
    }'
Propiedad Descripción
auth.params.s3AccessKey La clave de acceso asociada a su S3 cubo.
auth.params.s3SecretKey Su clave secreta asociada a su S3 cubo.
auth.params.s3SessionToken (Opcional) El plazo corto, temporal S3 token utilizado para acceder a su espacio de.
connectionSpec.id El S3 identificador de especificación de conexión: 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 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.

IMPORTANTE

El If-Match es necesario para 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 Flow Service API, mientras proporciona su ID de conexión.

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

En esta página