1. 简介

1.1 功能概述

英雄云开放平台提供 API 开发文档，支持开发人员快速了解各业务模块的接口能力，可通过用角色、部门、成员、应用、表单、记录、文件及工作流等接口，实现外部系统与英雄云之间的数据同步与业务联动。

1.2 应用场景

第三方系统调用接口实现数据同步。
通过外部系统新增或更新英雄云表单数据.
文件上传与业务数据关联处理。
企业组织架构同步（部门/成员/角色）。

2. 设置入口

2.1 操作入口

进入「首页 >> 开放平台」界面，点击「开发文档」，选择「API 文档」，即可进入。

2.2 API 模块说明

当前 API 接口分为 9 大模块：

模块	功能说明
角色模块	角色查看、创建、修改、删除
角色组模块	角色组查看、创建、修改、删除
部门模块	部门查询、创建、修改、删除
成员模块	成员查询、修改、启用、禁用
应用模块	应用查询接口
表单模块	单个表单查询接口
记录模块	记录新增、查询、修改、删除
文件模块	OSS临时凭证获取、文件上传
工作流模块	待办列表、审批、拒绝等接口

3. 使用教程

使用示例：通过第三方系统调用「新增一条记录接口」，触发英雄云表单新增一条记录。

3.1 获取API Key

API Key 是一种用于在客户端和服务器之间进行身份验证 and 授权的安全令牌。通过使用 API Key，服务提供商可以验证请求的来源是否合法，并根据 API Key 的权限设置来限制或允许对特定资源的访问。

操作步骤：点击「首页 >> 开放平台 >> 密钥管理」，创建 API Key 或复制已有的 API Key，作为第三方系统调用英雄云「新增一条记录接口」的身份验证和授权的安全令牌。具体操作可参考文档：密钥管理。

3.2 配置接口参数

根据英雄云提供的开发文档，在第三方系统配置调用接口参数。具体参数可见文档：记录模块。

接口地址：https://www.yingxiongyun.com/worksheet/api/v1/t/app/{applicationId}/form/{formId}/records
请求方式：POST
consumes：["application/json"]
produces：["*/*"]
接口描述：新增一条记录

3.3 第三方发送请求

完成 「3.2 配置接口参数」 后即可在第三方系统触发请求。

3.4 查看API调用日志

完成 「3.3 第三方发送请求」 后即可在英雄云平台查看到API调用日志。

4. 注意事项

接口授权 ：调用 API 文档中的接口前，请确保所使用的 API Key 已获得该应用或对应接口的授权范围。
身份鉴权 ：所有接口请求均需配合有效的 API Key 进行身份验证。
调用安全 ：建议配合 IP 白名单功能使用，以确保接口调用的安全性。