> ## 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 參考概觀，介紹用於以程式設計方式管理資源和執行函式的 REST 介面。

export const siteNameShort = "知行之橋";

export const siteName = "知行之橋";

**API 參考文件** 記錄了 {siteName} 系統 API 的所有介面。系統 API 是用於以程式設計方式管理 {siteNameShort} 例項的 REST 介面。各頁面分別介紹一項操作，包括 HTTP 方法、路徑、參數和回應架構；內容直接根據系統 API 的 OpenAPI 規範生成。

要了解這些介面所基於的概念，包括身分驗證、`/api.rsc/` 介面約定、CORS 和篩選，請先閱讀知行之橋使用者手冊中的[系統 API 指南](../admin-api/admin-api)。本參考文件按**資源**和**函式**分組，逐項說明各個介面。

## 資源

資源是可以使用標準 HTTP 方法（`GET`、`POST`、`PUT`、`DELETE`）查詢、建立、更新和刪除的物件。每種資源都透過 `/api.rsc/<resource>` 公開。

| 分類               | 內容                                        |
| ---------------- | ----------------------------------------- |
| **Certificates** | 用於加密、簽章、解密、驗證和 SSL/TLS 的數字憑證。             |
| **Connectors**   | 工作流程中的端口配置，可以檢索、新增、更新或刪除端口。               |
| **Files**        | 工作流程中的檔案，可以檢索、更新或刪除檔案，也可以將新檔案推送到端口的輸入資料夾。 |
| **Logs**         | 應用程式日誌中的項目，用於記錄應用程式級錯誤。                   |
| **Profile**      | 應用程式的本地配置檔案設定。                            |
| **Reports**      | 應用程式中定義的報表。                               |
| **Requests**     | 存取日誌中的項目，用於記錄傳入的 HTTP 請求。                 |
| **Transactions** | 交易日誌中繼資料，用於記錄成功和失敗的檔案傳送及接收操作。             |
| **Vault**        | 配置庫專案，包括儲存的機密資訊和可複用的配置值。                  |
| **Workspaces**   | 用於組織端口的工作區。                               |

## 函式

**函式**用於執行資源 CRUD 之外的管理和端口操作，透過向 `/api.rsc/<actionName>` 傳送 HTTP `POST` 請求呼叫。這些函式可用於清理日誌和資料夾、複製端口和工作區、建立和交換憑證、匯入和匯出設定及加密金鑰、重新排隊和統計訊息、傳送和接收檔案，以及檢索交易日誌。

完整函式清單及其參數請參閱[函式](../admin-api/admin-api-actions)頁面。