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 Azure Blob (en lo sucesivo, "Blob") utilizando el Flow Service API.
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 crear correctamente una Blob conexión de origen mediante Flow Service API.
Para que Flow Service para conectarse con su Blob almacenamiento, debe proporcionar valores para la siguiente propiedad de conexión:
Credencial | Descripción |
---|---|
connectionString |
Cadena que contiene la información de autorización necesaria para la autenticación Blob al Experience Platform. El Blob el patrón de cadena de conexión es: DefaultEndpointsProtocol=https;AccountName={ACCOUNT_NAME};AccountKey={ACCOUNT_KEY} . Para obtener más información acerca de las cadenas de conexión, consulte esto Blob documento en configurar cadenas de conexión. |
sasUri |
El URI de firma de acceso compartido que puede utilizar como tipo de autenticación alternativo para conectar su Blob cuenta. El Blob El patrón de URI de SAS es: https://{ACCOUNT_NAME}.blob.core.windows.net/?sv=<storage version>&st={START_TIME}&se={EXPIRE_TIME}&sr={RESOURCE}&sp={PERMISSIONS}>&sip=<{IP_RANGE}>&spr={PROTOCOL}&sig={SIGNATURE}> Para obtener más información, consulte Blob documento en URI de firma de acceso compartido. |
container |
El nombre del contenedor al que desea designar el acceso. Al crear una cuenta nueva con Blob origen, puede proporcionar un nombre de contenedor para especificar el acceso del usuario a la subcarpeta que elija. |
folderPath |
La ruta a la carpeta a la que desea proporcionar acceso. |
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 Blob es: d771e9c1-4f26-40dc-8617-ce58c4b53702 . |
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 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.
El Blob El origen admite la autenticación de cadena de conexión y firma de acceso compartido (SAS). Un URI de firma de acceso compartido (SAS) permite la autorización delegada segura a su Blob cuenta. Puede utilizar SAS para crear credenciales de autenticación con distintos grados de acceso, ya que la autenticación basada en SAS le permite establecer permisos, fechas de inicio y caducidad, así como disposiciones para recursos específicos.
Durante este paso, también puede designar las subcarpetas a las que tendrá acceso su cuenta definiendo el nombre del contenedor y la ruta de acceso a la subcarpeta.
Para crear un ID de conexión base, realice una solicitud de POST al /connections
extremo al proporcionar su Blob 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 Blob uso de la autenticación basada en cadenas de conexión:
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": "Azure Blob connection using connectionString",
"description": "Azure Blob connection using connectionString",
"auth": {
"specName": "ConnectionString",
"params": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName={ACCOUNT_NAME};AccountKey={ACCOUNT_KEY}",
"container": "acme-blob-container",
"folderPath": "/acme/customers/salesData"
}
},
"connectionSpec": {
"id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
"version": "1.0"
}
}'
Propiedad | Descripción |
---|---|
auth.params.connectionString |
Cadena de conexión necesaria para acceder a los datos del almacenamiento del blob. El patrón de cadena de conexión de blob es: DefaultEndpointsProtocol=https;AccountName={ACCOUNT_NAME};AccountKey={ACCOUNT_KEY} . |
connectionSpec.id |
El ID de especificación de la conexión de almacenamiento del blob es: 4c10e202-c428-4796-9208-5f1f5732b1cf |
Para crear un Blob conexión de blob con el URI de firma de acceso compartido, realice una solicitud de POST al Flow Service API mientras proporciona valores para su Blob sasUri
.
La siguiente solicitud crea una conexión base para Blob uso del URI de firma de acceso compartido:
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": "Azure Blob source connection using SAS URI",
"description": "Azure Blob source connection using SAS URI",
"auth": {
"specName": "SAS URI Authentication",
"params": {
"sasUri": "https://{ACCOUNT_NAME}.blob.core.windows.net/?sv={STORAGE_VERSION}&st={START_TIME}&se={EXPIRE_TIME}&sr={RESOURCE}&sp={PERMISSIONS}>&sip=<{IP_RANGE}>&spr={PROTOCOL}&sig={SIGNATURE}>",
"container": "acme-blob-container",
"folderPath": "/acme/customers/salesData"
}
},
"connectionSpec": {
"id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
"version": "1.0"
}
}'
Propiedad | Descripción |
---|---|
auth.params.connectionString |
El URI de SAS necesario para acceder a los datos de su Blob almacenamiento. El Blob El patrón de URI de SAS es: https://{ACCOUNT_NAME}.blob.core.windows.net/?sv=<storage version>&st={START_TIME}&se={EXPIRE_TIME}&sr={RESOURCE}&sp={PERMISSIONS}>&sip=<{IP_RANGE}>&spr={PROTOCOL}&sig={SIGNATURE}> . |
connectionSpec.id |
El Blob ID de especificación de conexión de almacenamiento: 4c10e202-c428-4796-9208-5f1f5732b1cf |
Respuesta
Una respuesta correcta devuelve detalles de la conexión base recién creada, incluido su identificador único (id
). Este ID es necesario en el siguiente paso para crear una conexión de origen.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"1700c57b-0000-0200-0000-5e3b3f440000\""
}
Al seguir este tutorial, ha creado un Blob Se obtuvo una conexión mediante API y 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.