API-guide för dataåtkomst

API:t för dataåtkomst stöder Adobe Experience Platform genom att förse användarna med ett RESTful-gränssnitt som fokuserar på identifierbarhet och tillgänglighet för kapslade datauppsättningar i Experience Platform.

API-specifikationsreferens

OpenAPI-referensdokumentationen finns här.

Terminologi terminology

Tabellen innehåller en beskrivning av några termer som används ofta i det här dokumentet.

Hämta en lista med filer i en grupp retrieve-list-of-files-in-a-batch

Om du vill hämta en lista med filer som tillhör en viss grupp använder du batch-ID:t (batchID) med API:t för dataåtkomst.

API-format

GET /batches/{BATCH_ID}/files

Begäran

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}'

Svar

{
  "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
  }
}

Arrayen "data" innehåller en lista med alla filer i den angivna gruppen. Varje returnerad fil har ett eget unikt ID ({FILE_ID}) som finns i fältet "dataSetFileId". Du kan använda detta unika ID för att komma åt eller hämta filen.

Få tillgång till och ladda ned filer i en grupp

Om du vill komma åt specifik information om en fil använder du en filidentifierare ({FILE_ID}) med API:t för dataåtkomst, inklusive namn, storlek i byte och en länk som ska hämtas.

Svaret innehåller en datamatris. Beroende på om filen som ID:t pekar på är en enskild fil eller en katalog, kan den returnerade datarrayen innehålla en enda post eller en lista med filer som tillhör den katalogen. Varje filelement innehåller information om filen.

API-format

GET /files/{FILE_ID}

Begäran

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}'

Svar på enstaka fil

{
  "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
  }
}

Katalogsvar

{
  "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
  }
}

När en katalog returneras innehåller den en array med alla filer i katalogen.

Åtkomst till innehållet i en fil access-file-contents

Du kan också använda API:t Data Access för att komma åt innehållet i en fil. Du kan sedan hämta innehållet till en extern källa.

API-format

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

Begäran

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}'

Svar

Contents of the file

Ytterligare kodexempel

Fler exempel finns i dataåtkomstsjälvstudiekursen.

Prenumerera på dataöverföringshändelser subscribe-to-data-ingestion-events

Du kan prenumerera på specifika värdefulla händelser via Adobe Developer Console. Du kan t.ex. prenumerera på dataöverföringshändelser för att få meddelanden om eventuella förseningar och fel. Mer information finns i självstudiekursen om att prenumerera på meddelanden om dataöverföring.