飞连提供了一系列丰富的 OpenAPI，允许您将企业现有的 IT 系统与飞连进行深度集成，以实现用户、设备、策略等信息的自动化同步与管理。

为了帮助您更好地进行开发，飞连提供了一个集中的开发者中心——“开放平台”。

平台概述 #

飞连开放平台是一个集 API 文档、开发指南、事件订阅和更新日志于一体的开发者中心。它旨在为企业开发者和合作伙伴提供一个集中、在线、实时更新的资源门户，以更高效、更安全地与飞连进行系统集成，助力企业打造办公安全一体化平台。
通过开放平台，您可以：

• 探索开放能力：全面了解飞连在身份认证、组织架构、终端管理、安全管控等多个领域所开放的 API 接口和事件。
• 学习集成方法：通过详尽的《开发指南》，掌握获取访问凭证、构造 API 请求和订阅 Webhook 事件的标准流程。
• 获取 OpenAPI 说明：在《开发文档》中，按模块查找每个 OpenAPI 的详细技术规范，包括请求参数、响应结构和代码示例。
• 追踪版本更新：通过《更新日志》，及时获知每个版本的新增功能、不兼容变更以及接口的废弃情况。

平台入口 #

1. 登录管理后台。
2. 在页面右上角的顶部导航栏中，点击头像，选择开放平台。
3. 系统将在新的浏览器标签页中打开开放平台首页。

Access Key 是您在调用飞连 OpenAPI 时，用于证明自身身份并获取操作权限的核心凭证。在使用飞连 OpenAPI 之前，您需要在飞连管理后台创建 API 访问秘钥（AccessKey）供指定范围内的员工使用。

创建 Access Key #

1. 登录管理后台。

2. 在左侧导航栏，选择系统设置 > 集成管理 ＞ API 管理。

3. 在 API 管理页面右上角，单击创建 Access Key。

4. 在创建 Access Key 对话框，完成以下配置，并单击确定。
   
   配置项说明：

   配置项	说明
   权限范围	设置当前 AccessKey 可以使用的员工范围，可选全公司或者特定部门。 全公司：企业内所有员工均可使用该 AccessKey 调用 OpenAPI。 特定部门：在搜索部门下拉列表中，手动添加部门，支持添加多个。后续仅被添加的部门范围内的员工可以使用该 AccessKey 调用 OpenAPI。
   添加接口权限	飞连 OpenAPI 按功能模块划分共计 68 个权限，您可以根据实际需要，配置当前 AccessKey 支持调用的接口权限范围。
   用途	自定义用途信息，用于标识当前 AccessKey 的实际用途。
   AccessKey 调用频率限制	使用该 AccessKey 授权调用 API 的总体频率限制。默认值 100 qps。
   单接口调用频率	使用该 AccessKey 授权调用单个 API 的频率限制。默认值 20 qps。
   IP 白名单	设置 API 请求的 IP 地址白名单。支持的格式为： IP 范围。例如，10.10.56.217-10.10.56.218。 CIDR。例如，10.10.0.0/24 或者 10.10.0.0。 多个 IP 地址之间使用逗号或者空格间隔。

5. 创建完成后，在列表中获取 AccessKey ID 和 AccessKey Secret。
   其中：

   • 确保 AccessKey 状态为启用状态。更多信息请参见启用或禁用 AccessKey。
   • AccessKey Secret 需要单击显示，在 AccessKey 详情对话框查看。在对话框内可直接复制 AccessKey ID 或者 AccessKey Secret。
     

启用或禁用 AccessKey #

已创建的 AccessKey 支持手动禁用，禁用后员工无法再使用该 AccessKey 调用 OpenAPI，后续可根据实际需要重新启用。
在 API 管理页面，找到指定 AccessKey，在操作列单击禁用或启用。

• 禁用：当 AccessKey 为启用状态时，您可以根据需要选择禁用 AccessKey，禁用后员工无法再使用该 AccessKey 调用 OpenAPI。
• 启用：当 AccessKey 为禁用状态时，您可以根据需要选择启用 AccessKey。

查看或编辑 AccessKey 详细信息 #

在 API 管理页面，找到指定 AccessKey，在操作列单击查看详情进入 AccessKey 详情页面，查看基本信息与开发设置。

删除 AccessKey #

在 API 管理页面，找到指定 AccessKey，在操作列单击删除。

为满足安全合规审计需求并帮助管理员排查 API 调用异常，飞连提供结构化的 API 调用日志。

访问路径 #

• 方式一：全局查询
  
  1. 登录管理后台。
  2. 在左侧导航栏，选择系统设置 > 集成管理 ＞ API 管理。
  3. 点击右侧日志查询，进入日志查询页面，可查看租户维度下所有的 API 调用记录。也可通过 AccessKey 筛选项来过滤指定密钥的日志。
• 方式二：单 AccessKey 查询
  
  1. 登录管理后台。
  2. 在左侧导航栏，选择系统设置 > 集成管理 ＞ API 管理。
  3. 在 AccessKey 列表中找到指定的 AK，在操作列单击查看详情进入详情页面。
  4. 切换至日志查询页签。系统将直接为您展示其关联的日志。

日志解读 #

进入日志查询页面后，您可以通过以下模块分析 API 调用情况：

• 筛选区：支持按调用时间、源 IP、请求 ID、请求 URL、返回状态、错误码、错误信息等核心字段进行过滤。
• 调用趋势图：直观展示调用量随时间的变化情况。默认显示最近一天时间范围内的调用量数据。
• 日志详情列表：以表格形式展示符合条件的调用明细。
  • 查看详情：点击列表操作列的详情，可查看该条日志的完整请求参数和响应结果。
  • 导出日志：点击列表右上角的导出列表，可将当前查询结果导出为 CSV 或 Excel 文件（单次上限 10,000 条）。

日志存储 #

关于 API 调用日志的存储与查询期限，请参考以下说明：

• 页面查询期限：管理后台页面支持查询近 30 天内的 API 调用日志。
• 系统存储时长：API 调用日志在飞连底层系统默认保留 180 天。

说明：为满足更长周期的审计合规需求，建议您配置日志外发功能，将 API 调用日志实时同步至企业自有的 Syslog 或 Elasticsearch 服务器中长期留存。详细操作说明参看日志审计与外发配置指南。