開始使用Adobe Experience Platform API

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

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

驗證和標題

若要成功呼叫平台端點,您必須完成 驗證教學課程. 完成驗證教學課程會提供Experience PlatformAPI呼叫中每個必要標題的值,如下所示:

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

沙箱標題

Experience Platform中的所有資源都會隔離至特定的虛擬沙箱。 向Platform API提出的請求需要標頭,指定要在中執行作業的沙箱名稱:

  • x-sandbox-name: {SANDBOX_NAME}

如需Platform中沙箱的詳細資訊,請參閱 沙箱概述檔案.

內容類型標題

要求內文中包含裝載的所有要求(例如POST、PUT和PATCH呼叫)都必須包含 Content-Type 頁首。 接受的值是每個API端點專屬的值。 若 Content-Type 端點需要值,其值會顯示在由提供的範例API請求中 個別Platform服務的API指南.

Experience PlatformAPI基礎知識

Adobe Experience Platform API採用數種須了解的基礎技術和語法,以有效管理Platform資源。

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

Experience PlatformAPI的Postman集合

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

若要進一步了解Postman,包括如何設定環境、可用集合清單以及如何匯入集合,請造訪 Platform Postman檔案.

讀取範例API呼叫

請求格式會依使用的平台API而異。 若要了解如何建構API呼叫,最佳方式是遵循檔案中針對您所使用之特定Platform服務提供的範例。

的檔案 Experience Platform 以兩種不同的方式顯示範例API呼叫。 首先,呼叫會呈現在 API格式,此範本表示僅顯示操作(GET、POST、PUT、PATCH、DELETE)和使用的端點(例如 /global/classes)。 有些範本也會顯示變數的位置,以協助說明應如何制定呼叫,例如 GET /{VARIABLE}/classes/{ANOTHER_VARIABLE}.

接著,這些呼叫會在 要求,包括成功與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: {IMS_ORG}' \
  -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服務的疑難排解指南,請參閱 服務疑難排解目錄.

如需Platform API中特定端點的詳細資訊,包括必要的標題和要求內文,請參閱 平台API指南.

平台API指南

API指南 說明
Access Control API指南 此 Access Control API端點可以擷取對指定沙箱內指定資源上的使用者有效的目前原則。 所有其他存取控制功能皆透過 Adobe Admin Console.
批次內嵌API指南 Adobe Experience Platform Data Ingestion API可讓您將資料以批次檔案的形式內嵌至Platform。 所擷取的資料可以是來自CRM系統中一般檔案(例如Parquet檔案)的設定檔資料,或符合結構註冊表(XDM)中已知結構的資料。
Catalog Service API指南 此 Catalog Service API可讓開發人員管理Adobe Experience Platform中的資料集中繼資料。 這包括資料位置、處理階段、處理期間發生的錯誤,以及資料報表。
Data Access API指南 此 Data Access API可讓開發人員擷取Experience Platform內擷取之資料集的相關資訊。 這包括存取和下載資料集檔案、擷取標題資訊、列出失敗和成功的批次,以及下載預覽CSV / Parquet檔案。
Dataset Service API指南 資料集服務API可讓您套用及編輯資料集的使用量標籤。 此API是Adobe Experience Platform資料目錄功能的一部分,但與管理資料集中繼資料的目錄服務API不同。
Identity Service API指南 此 Identity Service API可讓開發人員使用Adobe Experience Platform中的身分圖表,管理客戶的跨裝置、跨通道和近乎即時的身分識別。
Observability Insights API指南 Observability Insights 是RESTful API,可讓開發人員公開Adobe Experience Platform中的關鍵可觀察量度。 這些量度可提供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指南
(資料科學工作區)
此 Sensei Machine Learning API為資料科學家提供一種機制,用於組織和管理從演算法上線、實驗到服務部署的機器學習(ML)服務。

有關每個服務可用的特定端點和操作的詳細資訊,請參閱 API參考檔案 Adobe I/O。

後續步驟

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

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

若要設定Postman環境並探索可用的Postman集合,請參閱 Platform Postman指南.

本頁內容