Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.
Este tutorial le guía por los pasos para crear una conexión base para Amazon S3 (en lo sucesivo, "elS3") usando la variable Flow Service API.
Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:
Las secciones siguientes proporcionan información adicional que debe conocer para conectarse correctamente a un S3 almacenamiento mediante Flow Service API.
Para Flow Service para conectarse con su S3 , debe proporcionar valores para las siguientes propiedades de conexión:
Credencial | Descripción |
---|---|
s3AccessKey |
El ID de clave de acceso para su S3 cubo. |
s3SecretKey |
El ID de clave secreta de su S3 cubo. |
serviceUrl |
(Opcional) El S3 punto final al que conectarse. Este campo es obligatorio cuando S3 bucket es específico de la región. El formato de serviceUrl es: https://s3.{REGION}.amazonaws.com/) . |
bucketName |
La variable S3 contiene los datos y sus metadatos descriptivos correspondientes. Su S3 el nombre del contenedor debe tener entre tres y 63 caracteres de longitud 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 pueden formatear como direcciones IP. |
folderPath |
La ruta a la carpeta de su S3 espacio 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 de confianza. Consulte la S3 información general para obtener más información. |
connectionSpec.id |
La especificación de conexión devuelve las propiedades del conector de un origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y de 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 this Amazon Web Services documento.
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.
Una conexión base retiene información entre la fuente y la plataforma, incluidas las credenciales de autenticación de la fuente, el estado actual de la conexión y el ID de conexión base único. El ID de conexión base le permite explorar y navegar 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
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 |
La clave secreta asociada a su S3 cubo. |
auth.params.s3SessionToken |
(Opcional) A corto plazo, temporal S3 token utilizado para acceder a su bucket. |
connectionSpec.id |
La variable S3 id. 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\""
}
Siguiendo este tutorial, ha creado una conexión S3 mediante API y se ha obtenido un ID único como parte del cuerpo de respuesta. Puede utilizar este ID de conexión para explorar las tiendas en la nube mediante la API de servicio de flujo.
La siguiente sección proporciona información adicional sobre el uso de la variable S3 fuente.
La variable s3SessionToken
es temporal y debe actualizarse cuando caduca. Puede actualizar el token de sesión asociado a la conexión base realizando una solicitud de PATCH a Flow Service API. Consulte la S3 información general para obtener más información sobre las credenciales de seguridad temporales para S3.
La variable If-Match
es obligatorio cuando se realiza 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 su ID de conexión base y una etiqueta actualizada. Puede comprobar la actualización realizando una solicitud de GET a la variable Flow Service al proporcionar su ID de conexión.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}