Adobe Experience Platform API快速入門

Last update: Tue Nov 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
API

建立對象：

開發人員

Adobe Experience Platform是根據「API優先」的理念所開發。使用Platform API，您可以利用程式設計方式針對資料執行基本CRUD （建立、讀取、更新、刪除）操作，例如設定計算屬性、存取資料/實體、匯出資料、刪除不需要的資料或批次等。

每個Experience Platform服務的API都共用相同的驗證標題集，並對其CRUD操作使用類似的語法。下列指南概述開始使用Platform API的必要步驟。

驗證和標頭

為了成功呼叫Platform端點，您必須完成驗證教學課程。完成驗證教學課程，提供Experience Platform API呼叫中每個必要標題的值，如下所示：

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

沙箱標頭

Experience Platform中的所有資源都會隔離至特定的虛擬沙箱。對Platform API的請求需要標頭，該標頭會指定將在其中執行操作的沙箱名稱：

x-sandbox-name: {SANDBOX_NAME}

如需Platform中沙箱的詳細資訊，請參閱沙箱概觀檔案。

Content-type標頭

要求內文中具有裝載的所有要求(例如POST、PUT和PATCH呼叫)都必須包含Content-Type標頭。接受的值是每個API端點專屬的值。如果端點需要特定Content-Type值，其值將顯示在個別平台服務API指南所提供的API要求範例中。

Experience PlatformAPI基礎知識

Adobe Experience Platform API運用多種基礎技術和語法，這些技術和語法對於有效管理Platform資源非常重要。

若要進一步瞭解Platform使用的基礎API技術，包括範例JSON結構描述物件，請造訪Experience Platform API基礎知識指南。

Experience Platform API的Postman集合

Postman是API開發的共同作業平台，可讓您使用預設變數設定環境、共用API集合、簡化CRUD請求等。大部分的Platform API服務都有Postman集合，可用來協助進行API呼叫。

若要深入瞭解Postman，包括如何設定環境、可用集合清單，以及如何匯入集合，請瀏覽Platform Postman檔案。

讀取範例 API 呼叫 sample-api

請求格式會因使用的平台API而異。要瞭解如何架構API呼叫，最好的方式是遵循檔案中針對您使用的特定平台服務提供的範例。

Experience Platform的檔案以兩種不同的方式顯示API呼叫範例。首先，呼叫以其 API格式 呈現，範本表示僅顯示作業(GET、POST、PUT、PATCH、DELETE)和正在使用的端點（例如/global/classes）。有些範本也會顯示變數的位置，以協助說明呼叫的建構方式，例如GET /{VARIABLE}/classes/{ANOTHER_VARIABLE}。

然後，這些呼叫會在要求中顯示為cURL命令，其中包括成功與API互動所需的必要標題和完整「基底路徑」。基礎路徑應預先附加到所有端點。例如，上述的/global/classes端點會變成https://platform.adobe.io/data/foundation/schemaregistry/global/classes。您將在整份檔案中看到API格式/請求模式，並預期當您對Platform API發出自己的呼叫時，會使用範例請求中顯示的完整路徑。

範例API請求

以下範例API請求會示範您將在檔案中遇到的格式。

API格式

API格式會顯示使用的操作(GET)和端點。變數以大括弧表示（在此例中為{CONTAINER_ID}）。

GET /{CONTAINER_ID}/classes

要求

在此範例請求中，API格式的變數在請求路徑中被指定實際值。此外，所有必要的標頭都會顯示為範例標頭值或變數，其中應包含敏感資訊（例如安全性權杖和存取ID）。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -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}'

回應

回應會根據傳送的請求，說明在成功呼叫API後您會收到的內容。有時候，回應會截斷空格，表示您可能會看到範例中顯示的詳細資訊或其他資訊。

{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

錯誤訊息

平台疑難排解指南提供您使用任何Experience Platform服務時可能遇到的錯誤清單。

如需個別平台服務的疑難排解指南，請參閱服務疑難排解目錄。

如需有關Platform API中特定端點的詳細資訊，包括必要的標頭和請求內文，請參閱Platform API指南。

平台API指南 api-guides

API指南

說明

Access Control API指南

Access Control API端點可以在指定沙箱內的指定資源上，擷取目前有效的使用者原則。所有其他存取控制功能是透過Adobe Admin Console提供。

批次擷取API指南

Adobe Experience Platform Data Ingestion API可讓您將資料以批次檔案的形式擷取到Platform。所擷取的資料可以是CRM系統中平面檔案（例如Parquet檔案）的設定檔資料，或是符合Schema Registry (XDM)中已知結構的資料。

Catalog Service API指南

Catalog Service API可讓開發人員在Adobe Experience Platform中管理資料集中繼資料。這包括資料位置、處理階段、處理期間發生的錯誤以及資料報表。

Data Access API指南

Data Access API可讓開發人員擷取Experience Platform內擷取之資料集的資訊。這包括存取和下載資料集檔案、擷取標題資訊、列出失敗和成功的批次，以及下載預覽CSV / Parquet檔案。

Dataset Service API指南

資料集服務API可讓您套用及編輯資料集的使用標籤。它是Adobe Experience Platform資料目錄功能的一部分，但與管理資料集中繼資料的目錄服務API不同。

Data Hygiene API guide

Data Hygiene API可讓您以程式設計方式修正或刪除客戶在Adobe Experience Platform中儲存的個人資料，以及排程資料集的到期日。

Edge Network Server API指南

Edge Network Server API可用於各種資料收集、個人化、廣告和行銷使用案例。 Server API可用於伺服器、IoT裝置、機上盒和其他各種裝置。

Identity Service API指南

Identity Service API可讓開發人員在Adobe Experience Platform中使用身分圖表來管理跨裝置、跨頻道及幾乎即時的客戶身分識別。

MTLS Service API guide

MTLS Service API可讓您安全地擷取Adobe為您的組織所發行的公開憑證。

Observability Insights API指南

Observability Insights是RESTful API，可讓開發人員在Adobe Experience Platform中公開金鑰可觀察性度量。這些量度提供平台使用統計資料、Platform服務健康情況檢查、歷史趨勢和各種Platform功能績效指標的深入分析。

Policy Service API指南
（資料控管）

Policy Service API可讓您建立和管理資料使用標籤和原則，以決定可以對包含特定資料使用標籤的資料採取哪些行銷動作。若要將標籤套用至資料集和欄位，請參閱Dataset Service API指南

Privacy Service API指南

Privacy Service API可讓開發人員依照隱私權法規，建立及管理客戶在所有Experience Cloud應用程式中存取或刪除其個人資料的請求。

Query Service API指南

Query Service API可讓開發人員使用標準SQL查詢其Adobe Experience Platform資料。

Real-Time Customer Profile API指南

即時客戶設定檔API可讓開發人員探索和使用設定檔資料，包括檢視設定檔、建立和更新合併原則、匯出或取樣設定檔資料，以及刪除不再需要或錯誤新增的設定檔資料。

沙箱API指南

沙箱API可讓開發人員以程式設計方式管理Adobe Experience Platform中的隔離虛擬沙箱環境。

Schema Registry API指南
(XDM)

Schema Registry API可讓開發人員以程式設計方式管理Adobe Experience Platform中的所有結構描述和相關的Experience Data Model (XDM)資源。

Segmentation Service API指南

Segmentation Service API可讓開發人員以程式設計方式管理Adobe Experience Platform中的細分作業。這包括建立區段，以及從您的即時客戶設定檔資料產生對象。

Sensei Machine Learning API指南
(資料科學Workspace)

Sensei Machine Learning API為資料科學家提供了一種機制，可用於組織和管理機器學習(ML)服務，從演演算法上線、實驗到服務部署。

如需每個服務可用的特定端點和作業的詳細資訊，請參閱Adobe I/O上的API參考檔案。

後續步驟

本檔案介紹了必要的標頭、可用的指南，並提供API呼叫的範例。現在您已擁有在Adobe Experience Platform上進行API呼叫所需的標頭值，請從Platform API指南表格中選取您要探索的API端點。

如需常見問題的解答，請參閱平台疑難排解指南。

若要設定Postman環境並探索可用的Postman集合，請參閱平台Postman指南。

recommendation-more-help

5741548a-2e07-44b3-9157-9c181502d0c5