Adobe Experience Platform 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資源非常重要。
若要進一步瞭解平台運用的基礎API技術,包括範例JSON結構描述物件,請造訪 Experience PlatformAPI基礎知識 指南。
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中特定端點的詳細資訊,包括必要的標題和請求內文,請參閱 平台API指南.
平台API指南 api-guides
(資料控管)
(資料科學工作區)
如需每個服務可用的特定端點和作業的詳細資訊,請參閱 API參考檔案 在Adobe I/O上。
後續步驟
本檔案介紹了必要的標頭、可用的指南,並提供API呼叫的範例。 您現在擁有在Adobe Experience Platform上進行API呼叫所需的標頭值,請從以下位置選取您要探索的API端點: 平台API指南表格.
若需常見問題的解答,請參閱 平台疑難排解指南.
若要設定Postman環境並探索可用的Postman集合,請參閱 Platform Postman指南.