> ## 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 函式概覽，用於執行標準資源 CRUD 之外的操作。

export const siteNameShort = "知行之橋";

export const siteName = "知行之橋";

API 函式擴充套件了可對[系統 API 資源](./admin-api-resources)執行的操作集。函式也可以執行與特定資源無關的操作。函式始終使用 HTTP POST 呼叫。

每個函式都使用以下約定在專用的應用程式端點公開：`/api.rsc/actionName`。例如，如果 {siteName} 託管在 **mydomain.com** 上並監聽 8001 端口，則將使用以下端點來存取 **cleanup** 函式：

```xml theme={null}
POST http://mydomain.com:8001/api.rsc/cleanup
```

函式參數在 HTTP POST 的 JSON 格式正文中指定。請求必須包含適當的 content-type 標頭（例如 application/json），以便正確解釋 POST 正文。點選 {siteName} 導覽列上的 **API** 可檢視每個函式的可用參數。

系統 API 包含以下函式：

| 函式                          | 描述                                                                      |
| --------------------------- | ----------------------------------------------------------------------- |
| **cleanup**                 | 歸檔或刪除日誌檔案、資料庫中的交易項目，以及（可選）指定工作區和端口的 Send、Sent 和 Received 資料夾中的檔案。       |
| **copyConnector**           | 使用現有端口配置建立新的 {siteNameShort} 端口。                                        |
| **copyWorkspace**           | 建立新的 {siteNameShort} 工作區，並複製現有工作區中的所有端口。                                |
| **createCert**              | 建立新的數字憑證（公開金鑰/私密金鑰對），用於加密、簽章、解密、驗證、SSL/TLS 等。                           |
| **exchangeCert**            | 與交易夥伴交換指定憑證的公開金鑰。僅適用於 AS2 和 OFTP 端口。                                    |
| **export**                  | 根據個人設定、端口設定或工作區設定建立配置檔案（`.arcflow`）。                                    |
| **exportDataEncryptionKey** | 將主加密金鑰匯出為加密資料塊，其中包含資料加密金鑰及其相關加密中繼資料。                                    |
| **getMessageCount**         | 檢索一個或多個工作區中所有端口未傳送訊息的數量。                                                |
| **getTransactionLogs**      | 檢索特定交易的詳細交易日誌資料。                                                        |
| **import**                  | 從配置歸檔檔案（`.arcflow`）將個人設定、端口設定或工作區設定匯入到 {siteNameShort}。                 |
| **importDataEncryptionKey** | 將加密金鑰（通常從生產環境匯出）匯入到開發或測試例項中，使開發環境能夠解密來自生產備份或匯入的配置資料和憑據。                 |
| **moveConnector**           | 將端口（包括其設定、狀態、憑據引用和交易歷史記錄）從一個工作區移動到另一個工作區，或在同一工作區中重新命名該端口。移動成功後，原端口將被刪除。 |
| **receiveFile**             | 指示特定端口觸發端口的接收操作，以下載/接收特定檔案（適用於 FTP、SFTP 和 S3 端口）或所有適用檔案（基於端口配置）。        |
| **requeueMessage**          | 將訊息移回 Send 資料夾處理佇列，以便重新處理。                                              |
| **sendFile**                | 指示端口處理（上傳、傳送、轉換等）該端口 Send 資料夾中的檔案。                                      |
| **setFlow**                 | 為指定工作區設定流程連線。                                                           |