> ## 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>