Guía de API de acceso a datos

La API de acceso a datos admite Adobe Experience Platform al proporcionar a los usuarios una interfaz RESTful centrada en la detección y accesibilidad de conjuntos de datos ingeridos en Experience Platform.

Referencia de especificación de API

Consulte la Documentación de referencia de OpenAPI de acceso a datos para ver un formato estandarizado y legible por el equipo y facilitar así la integración, las pruebas y la exploración.

Terminología terminology

En la tabla se describen algunos términos que se utilizan normalmente en este documento.

Recuperar lista de archivos dentro de un lote retrieve-list-of-files-in-a-batch

Para recuperar una lista de archivos pertenecientes a un lote concreto, utilice el identificador de lote (batchID) con la API de acceso a datos.

Formato de API

GET /batches/{BATCH_ID}/files

Solicitud

curl -X GET https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/files \
  -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}'

Respuesta

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    },
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}

La matriz "data" contiene una lista de todos los archivos del lote especificado. Cada archivo devuelto tiene su propio identificador único ({FILE_ID}) contenido en el campo "dataSetFileId". Puede utilizar este ID único para acceder al archivo o descargarlo.

Acceso y descarga de archivos dentro de un lote

Para obtener acceso a detalles específicos de un archivo, use un identificador de archivo ({FILE_ID}) con la API de acceso a datos, incluido su nombre, tamaño en bytes y un vínculo para descargar.

La respuesta contiene una matriz de datos. Dependiendo de si el archivo al que apunta el ID es un archivo individual o un directorio, la matriz de datos devuelta puede contener una sola entrada o una lista de archivos pertenecientes a ese directorio. Cada elemento de archivo incluye los detalles del archivo.

Formato de API

GET /files/{FILE_ID}

Solicitud

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID} \
  -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}'

Respuesta de un solo archivo

{
  "data": [
    {
      "name": "{FILE_NAME}",
      "length": "{LENGTH}",
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}

Respuesta de directorio

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 2
  }
}

Cuando se devuelve un directorio, contiene una matriz de todos los archivos del directorio.

Acceder al contenido de un archivo access-file-contents

También puede usar la API Data Access para tener acceso al contenido de un archivo. A continuación, puede descargar el contenido en una fuente externa.

Formato de API

GET /files/{dataSetFileId}?path={FILE_NAME}

Solicitud

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME} \
  -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}'

Respuesta

Contents of the file

Ejemplos de código adicionales

Para obtener más ejemplos, consulte el tutorial de acceso a datos.

Suscripción a eventos de ingesta de datos subscribe-to-data-ingestion-events

Puede suscribirse a eventos de alto valor específicos mediante Adobe Developer Console. Por ejemplo, puede suscribirse a eventos de ingesta de datos para recibir notificaciones de posibles retrasos y errores. Consulte el tutorial sobre suscripción a notificaciones de eventos de Adobe para obtener más información.