Adaptive Planning REST API
基本 REST API 方法
Adaptive Planning API 具有三個一般區域︰
- 中繼資料擷取與操縱
- 資料擷取
- 資料建立/更新
用戶端可傳送 HTTP POST 要求至 Adaptive Planning 主 Web 服務端點，以調出 API 呼叫。端點已附加版本號碼，指出所呼叫的 API 版本。Adaptive Planning API 的目前版本是 v40︰
If your instance uses non-US based, regional authentication, then your authorization URLs and API endpoints vary based on your region. See Reference: Regional Authentication URLs.
https://api.adaptiveplanning.com/api/v40
API 版本通常會在 Adaptive Planning 產品的新版本發佈時更新，但並非所有產品版本都會產生新的 API 版本。在後續版本的 API 發布後，至少在一年內仍會繼續支援目前的版本。
若要查看 API 變更記錄，請參閱 「依版本劃分的 API 變更」。
HTTP POST 要求將包含 POST 資料，而這些資料本身就是 XML 文件。此 XML 文件包含每個 API 方法呼叫中出現的一些標準區段，以及每個 API 方法呼叫特有的其他一些區段。Adaptive Planning 伺服器會處理 API 方法呼叫，並將結果以另一個 XML 文件的形式傳回。與要求類似，回應 XML 文件的某些區段對於每個 API 方法都是相同的，而某些區段則特定於每個 API 方法。
所有資料擷取均以搜尋的形式完成。呼叫者會指定一些條件來比對某些元素，而伺服器會以符合這些條件的中繼資料實體或資料清單做為回應。資料的建立和更新是以大量上傳資料的形式完成，也可透過 POST 指令提交。
- 安全
- 所有 API 要求都是無狀態的單一動作要求。使用者每次單獨呼叫時都必須經過驗證，因此入侵者不會嘗試劫持任何現有的 Web 服務階段作業。所有 API 要求均已加密，因為要求必須使用 https 網頁通訊協定執行。執行動作之使用者的驗證憑證會做為 Web 服務要求內文的一部分傳送至 Adaptive Planning。這表示使用者的登入 ID 和密碼會在離開產生 Web 服務要求的電腦前由 Web 層加密，且僅在目標伺服器收到後才會解密。在 API 要求中驗證使用者並不會為此使用者建立持續性階段作業，每個個別的 Web 服務呼叫都必須分別驗證其使用者。
- 權限與資料存取控制
- 使用者不需要特殊權限即可存取 Web 服務。但是，提出 Web 服務要求的使用者必須具有必要的權限，才能實際執行所要求的動作。例如，若要呼叫 importStandardData Web 服務方法，使用者必須具有匯入權限。此外，Web 服務方法會將每次呼叫的輸出限制為發出要求的使用者可看到的資料集。例如，exportData Web 服務方法將傳回的資料限制為在呼叫使用者擁有的層級集中找到的資料。