概念︰Adaptive Adaptive Planning REST API

基本 REST API 方法

Adaptive Planning API 有 3 個一般區域︰

中繼資料擷取和操作

資料擷取

資料建立和更新

用戶端會傳送 HTTP POST 要求至Adaptive Planning主要 Web 服務端點，以調出 API 呼叫。端點包含版本號碼，此號碼指出正在使用的 API版本。Adaptive Planning API 的目前版本是 v40。

依據Adaptive Planning實例的位置，您的授權 URL 和 API 端點可能會有所不同。如需更多資訊，請參閱「Adaptive Planning驗證 URL 和 IP 位址。

https://api.adaptiveplanning.com/api/v40

API 版本通常會隨著新的Adaptive Planning產品版本更新，但並非所有產品版本都會產生新的 API版本。在後續 API版本發布後， Workday會在至少一年的時間內支援目前版本。

如需 API 變更記錄，請參閱「」API 變更 - 依版本。

HTTP POST 要求在 XML 文件中包含 POST 資料。此 XML 文件包含每個 API 方法呼叫中的標準區段，以及每個 API 方法呼叫的特定區段。Adaptive Planning伺服器會處理 API 方法呼叫，並將結果以另一個 XML 文件的形式傳回。與要求一樣，回應 XML 文件包含每個 API 方法相同的區段，以及每個 API 方法特有的區段。

所有資料擷取都會使用搜尋。呼叫者指定條件以比對多個元素，而伺服器以符合條件的中繼資料實體或資料清單做為回應。資料的建立和更新會使用大量資料上傳，這些資料也是透過 POST 指令提交。

安全

使用者必須在每次個別呼叫時都經過驗證，這樣才能消除入侵者劫持 Web 服務階段作業的可能性。

所有 API 要求都會加密，因為這些要求必須使用 HTTPS 網頁通訊協定。使用者的驗證憑證會做為 Web 服務要求內文的一部分傳送至Adaptive Planning 。這表示 Web 層會在使用者的登入 ID 和密碼離開產生 Web 服務要求的電腦之前對其進行加密，並僅在目標伺服器收到時解密。

在 API 要求中驗證使用者的身分不會為該使用者建立持續性階段作業；每個單獨的 Web 服務呼叫都必須分別驗證其使用者。

權限與資料存取控制

使用者不需要特殊權限即可存取 Web 服務。但是，提出 Web 服務要求的使用者必須具有必要的權限，才能執行要求的動作。範例︰使用者必須具有匯入功能
權限，才能呼叫 importStandardData Web 服務方法。

此外，Web 服務方法會將每次呼叫的輸出限制為發出要求的使用者可看到的資料集。範例︰exportData Web 服務方法將傳回的資料限制為在呼叫使用者擁有的層級上找到的資料。