API-handleiding voor gegevenstoegang

De API voor gegevenstoegang ondersteunt Adobe Experience Platform door gebruikers een RESTful-interface te bieden die is gericht op de detecteerbaarheid en toegankelijkheid van opgenomen datasets binnen Experience Platform .

API-specificatieverwijzing

Verwijs naar de de verwijzingsdocumentatie van OpenAPI van de Toegang van Gegevensom een gestandaardiseerd, machine-leesbaar formaat voor gemakkelijkere integratie, het testen, en de exploratie te bekijken.

Terminologie terminology

De tabel bevat een beschrijving van enkele termen die in dit document worden gebruikt.

Lijst met bestanden in een batch ophalen retrieve-list-of-files-in-a-batch

Als u een lijst wilt ophalen met bestanden die tot een bepaalde batch behoren, gebruikt u de batch-id (batchID) met de API voor gegevenstoegang.

API formaat

GET /batches/{BATCH_ID}/files

Verzoek

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

Reactie

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

De array "data" bevat een lijst met alle bestanden in de opgegeven batch. Elk geretourneerd bestand heeft een eigen unieke id ({FILE_ID}) in het veld "dataSetFileId" . Met deze unieke id kunt u het bestand openen of downloaden.

Bestanden in een batch openen en downloaden

Om tot specifieke details van een dossier toegang te hebben, gebruik een dossierherkenningsteken ({FILE_ID}) met de API van de Toegang van Gegevens, met inbegrip van zijn naam, grootte in bytes, en een verbinding om te downloaden.

De reactie bevat een gegevensarray. Afhankelijk van het feit of het bestand waarnaar de id verwijst een afzonderlijk bestand of een map is, kan de geretourneerde gegevensarray één item of een lijst met bestanden bevatten die tot die map behoren. Elk bestandselement bevat de details van het bestand.

API formaat

GET /files/{FILE_ID}

Verzoek

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

Enige dossierreactie

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

reactie van de Folder

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

Wanneer een map wordt geretourneerd, bevat deze een array van alle bestanden in de map.

De inhoud van een bestand openen access-file-contents

U kunt de API van Data Access ook gebruiken om tot de inhoud van een dossier toegang te hebben. U kunt de inhoud vervolgens downloaden naar een externe bron.

API formaat

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

Verzoek

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

Reactie

Contents of the file

Aanvullende codevoorbeelden

Voor extra steekproeven, verwijs naar het leerprogramma van de gegevenstoegang.

Abonneren op gebeurtenissen voor gegevensinvoer subscribe-to-data-ingestion-events

U kunt aan specifieke high-value gebeurtenissen door Adobe Developer Consoleintekenen. U kunt bijvoorbeeld een abonnement nemen op gebeurtenissen voor het opnemen van gegevens om op de hoogte te worden gebracht van mogelijke vertragingen en mislukkingen. Zie het leerprogramma op intekenend aan de gebeurtenisberichten van de Adobevoor meer informatie.