Uso de API de Experience Platform

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

Crear una conexión de origen

Puede crear una conexión de origen realizando una petición POST al extremo sourceConnections de la API Flow Service al mismo tiempo que proporciona el identificador de conexión base, la ruta de acceso al archivo de origen que desea introducir y el identificador de especificación de conexión correspondiente del origen.

Al crear una conexión de origen, también debe definir un valor de enumeración para el atributo de formato de datos.

Utilice los siguientes valores de enumeración para orígenes basados en archivos:

Formato de datosValor de enumeración
Delimitadodelimited
JSONjson
Parquetparquet

Para todos los orígenes basados en tablas, establezca el valor en tabular.

Formato de API

POST /sourceConnections

Solicitud

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
  -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": "Cloud Storage source connection",
      "description: "Source connection for a cloud storage source",
      "baseConnectionId": "1f164d1b-debe-4b39-b4a9-df767f7d6f7c",
      "data": {
          "format": "delimited",
          "properties": {
              "columnDelimiter": "{COLUMN_DELIMITER}",
              "encoding": "{ENCODING}",
              "compressionType": "{COMPRESSION_TYPE}"
          }
      },
      "params": {
          "path": "/acme/summerCampaign/account.csv",
          "type": "file"
      },
      "connectionSpec": {
          "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
          "version": "1.0"
      }
  }'
PropiedadDescripción
baseConnectionIdEl ID de conexión base del origen de almacenamiento en la nube.
data.formatEl formato de los datos que desea llevar a Experience Platform. Los valores admitidos son: delimited, JSON y parquet.
data.properties(Opcional) Conjunto de propiedades que se pueden aplicar a los datos al crear una conexión de origen.
data.properties.columnDelimiter(Opcional) Un delimitador de columna de un solo carácter que puede especificar al recopilar archivos planos. Cualquier valor de carácter único es un delimitador de columna admisible. Si no se proporciona, se usa una coma (,) como valor predeterminado. Nota: la propiedad columnDelimiter solo se puede usar al ingerir archivos delimitados.
data.properties.encoding(Opcional) Una propiedad que define el tipo de codificación que se utilizará al ingerir los datos en Experience Platform. Los tipos de codificación admitidos son: UTF-8 y ISO-8859-1. Nota: el parámetro encoding solo está disponible cuando se ingieren archivos CSV delimitados. Se incorporarán otros tipos de archivo con la codificación predeterminada, UTF-8.
data.properties.compressionType(Opcional) Una propiedad que define el tipo de archivo comprimido para la ingesta. Los tipos de archivo comprimidos admitidos son: bzip2, gzip, deflate, zipDeflate, tarGzip y tar. Nota: la propiedad compressionType solo se puede usar al ingerir archivos delimitados o JSON.
params.pathLa ruta del archivo de origen al que está accediendo. Este parámetro apunta a un archivo individual o a una carpeta completa. Nota: puede usar un asterisco en lugar del nombre de archivo para especificar la ingesta de una carpeta entera. Por ejemplo: /acme/summerCampaign/*.csv ingerirá toda la carpeta /acme/summerCampaign/.
params.typeEl tipo de archivo del archivo de datos de origen que está ingiriendo. Use el tipo file para ingerir un archivo individual y el tipo folder para ingerir una carpeta completa.
connectionSpec.idEl ID de especificación de conexión asociado con el origen de almacenamiento en la nube específico. Consulte el apéndice para obtener una lista de los ID de especificación de conexión.

Respuesta

Una respuesta correcta devuelve el identificador único (id) de la conexión de origen recién creada. Este ID es necesario en un paso posterior para crear un flujo de datos.

{
    "id": "26b53912-1005-49f0-b539-12100559f0e2",
    "etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}