概念︰偵聽器服務 API
若要使用已啟用的偵聽器服務將訊息發布至 Studio 整合，請使用偵聽器服務 API。使用提供的 REST API，您可以將自訂訊息 (由您或您要整合的外部服務定義) 發布至 Studio 整合。您可以張貼訊息，但前提是您已建立 Studio 整合功能，可辨識訊息並加以處理。
偵聽器服務 API 安全性
您的內傳 Web 服務 POST 作業必須使用 2 種方法中的一種進行驗證︰
- 基本驗證︰包含 Workday 使用者 ID 和密碼。Workday 使用者 ID 的格式為username@tenant_name，其中tenant_name是您要存取的用戶名稱
- OAuth︰包含您使用 cURL 要求取得的不記名存取權杖。在此流程中，您需要以下值︰
- 從您的 Workday API 用戶端︰用戶端 ID、授權端點和權杖端點。
- 從 PKCE 代碼產生器︰代碼驗證工具和提示。
- 從瀏覽器︰授權代碼。
為提高安全性，Workday 建議您使用 OAuth 驗證。
將 ISU 指派給整合系統時，執行偵聽器要求的使用者帳戶必須是授予啟動整合權限的安全群組的成員。
若未指派 ISU，執行偵聽器要求的使用者帳戶必須是一個或多個安全群組的成員，且這些群組可授予以下權限︰
- 啟動整合。
- 存取整合使用的所有資料 API。
每個用戶都有自己的統一資源識別碼 (URI)，您可以將 Web 服務的 Post 要求導向至此。如需最新端點，以及如何判斷資料中心和端點 URI 的資訊，請參閱 Workday Community 中的 Workday Data Centers (Workday 資料中心) 頁面。
在您的 API 呼叫中包含 HTTP 標頭 X-Tenant: tenant_name。
雲端儲存庫結構
您可以使用以下階層來存取已部署至 Workday 雲端資料庫的 Studio 整合︰
- 雲端儲存庫︰每個用戶都有一個雲端儲存庫。
- 集合︰每個雲端資料庫會儲存 1 或多個集合。每個集合都有唯一的集合名稱。
- 整合︰每個集合都包含 1 或多個 Studio 整合。每個整合都有唯一的名稱和workday_in_id值。
您可以使用以下 URI 格式指定 Studio 整合︰
Tenant_URI
/ccx/cc-Cloud-repo/launches/collective_name
/integration_name
/workday_in_id
?start_parameter_name
=值
︰變數 | 說明 |
|---|---|
Tenant_URI | 用戶的 URL。 |
collection_name | 識別集合。 |
integration_name | 特定的 Studio 整合。 |
workday_in_id | 整合專用的 ID。 |
可用的 Web 服務作業
偵聽器服務 API 提供單一 Post 作業，可將訊息傳送至 Studio 整合︰
種類 | 值 |
|---|---|
格式 | POST URI /ccx/cc-Cloud-repo/launches/collective_name /integration_name /workday_in_id |
範例 | POST https://enterprise-services1.myworkday.com/ccx/cc-Cloud-repo/collections/ HelloCloudCollection/ HelloCloud/StartHere |
回覆 | 將訊息發布至 Hello Cloud 整合。
如需使用偵聽器服務的整合範例，請參閱 Workday Community 上的 偵聽器服務 博文。 |