> ## 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 接口。

**API 参考文档** 记录了 知行之桥 系统 API 的所有接口。系统 API 是用于以编程方式管理 知行之桥 实例的 REST 接口。各页面分别介绍一项操作，包括 HTTP 方法、路径、参数和响应架构；内容直接根据系统 API 的 OpenAPI 规范生成。

要了解这些接口所基于的概念，包括身份验证、`/api.rsc/` 接口约定、CORS 和筛选，请先阅读知行之桥用户手册中的[系统 API 指南](https://docs.kasoftware.com/26.4/self-hosted/zh/admin-api/admin-api.md)。本参考文档按**资源**和**函数**分组，逐项说明各个接口。

## 资源

资源是可以使用标准 HTTP 方法（`GET`、`POST`、`PUT`、`DELETE`）查询、创建、更新和删除的对象。每种资源都通过 `/api.rsc/<resource>` 公开。

| 分类 | 内容 |
| - | - |
| **Audits** | 审计日志中的条目。此资源为只读，并且仅供管理员用户使用。 |
| **Certificates** | 用于加密、签名、解密、验证和 SSL/TLS 的数字证书。 |
| **Connectors** | 工作流中的端口配置，可以检索、新增、更新或删除端口。 |
| **Files** | 工作流中的文件，可以检索、更新或删除文件，也可以将新文件推送到端口的输入文件夹。 |
| **FlowAPIs** | 工作流端口公开的 REST API，可以检索每个 API 的 HTTP 方法、参数以及请求/响应配置。 |
| **FlowConnections** | 工作流中端口之间的连接，可以检索、创建、更新或删除工作流步骤之间的路由。 |
| **FlowNodes** | 工作流设计器中端口节点的可视化布局，可以检索、创建、更新或删除节点的位置和样式设置。 |
| **Logs** | 应用程序日志中的条目，用于记录应用程序级错误。 |
| **Profile** | 应用程序的本地配置文件设置。 |
| **Reports** | 应用程序中定义的报表。 |
| **Requests** | 访问日志中的条目，用于记录传入的 HTTP 请求。 |
| **Transactions** | 交易日志元数据，用于记录成功和失败的文件发送及接收操作。 |
| **Users** | 应用程序用户，可以检索、创建、更新或删除用户。仅供管理员用户使用。 |
| **Vault** | 配置库项目，包括存储的机密信息和可复用的配置值。 |
| **Workspaces** | 用于组织端口的工作区。 |

## 函数

**函数**用于执行资源 CRUD 之外的管理和端口操作，通过向 `/api.rsc/<actionName>` 发送 HTTP `POST` 请求调用。这些函数可用于清理日志和文件夹、复制端口和工作区、创建和交换证书、导入和导出设置及加密密钥、刷新凭据、重新排队和统计消息、发送和接收文件，以及检索交易日志。

完整函数列表及其参数请参阅[函数](https://docs.kasoftware.com/26.4/self-hosted/zh/admin-api/admin-api-actions.md)页面。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.