> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 系統 API

> 使用內建系統 API 透過 RESTful API 呼叫以程式設計方式管理知行之橋。

export const siteName = "知行之橋";

{siteName} 內建的系統 API 提供了一種靈活的方式來管理應用程式。在管理控制檯使用者介面中可以完成的所有操作，也可以透過 RESTful API 呼叫完成。有關每個介面及其操作的完整說明，請參閱 [API 參考文件 概觀](../api-reference/overview)。

系統 API 由一組 API [資源](./admin-api-resources)和一組 API [函式](./admin-api-actions)組成。可以組合呼叫這些資源和函式的 API，以從外部指令碼、伺服器和應用程式管理應用程式：

* 檢索應用程式工作流程中的檔案
* 檢索有關應用程式處理檔案的中繼資料或日誌資料
* 將檔案插入應用程式工作流程進行處理
* 更新端口或配置檔案設定
* 觸發端口的傳送/接收功能

系統 API 支援將 JSON 格式的 OData 作為預設 REST 協議。還支援其他 Web 服務格式，包括 OData (Atom)、SOAP、HTML 和 CSV。

## API 瀏覽器

[資源](./admin-api-resources)和[函式](./admin-api-actions)部分包含 API 中可用資源和函式的概觀。可以在 API 瀏覽器中找到有關每個資源和函式的更多資訊。

要存取 API 瀏覽器，請在導覽列上選擇 **API**。API 瀏覽器包括每個資源和函式的可用屬性，以及用於使用該 API 的程式碼範例（JQuery 和 cURL）。

<Note>一些標記為必填的 'Id' 屬性，可以透過組合其他屬性來指定。例如，如果檔案由 'ConnectorId'、'Folder' 和 'Filename' 的組合標識，則不需要 *Files* 資源的 'MessageId' 屬性來取得特定檔案。類似地，如果事先未知，則可以省略日誌資源（*Logs*、*Transactions* 和 *Requests*）的 Id。</Note>