更新日期

1. 功能概述

英雄云开放平台为有开发能力的企业提供了各类开发文档,通过文档中的API接口可以整合英雄云数据,实现第三方数据变更后及时执行相关的接口,完成数据同步到英雄云。
当前API接口主要有9大模块,点击下方链接可以查看相应开发文档:
角色模块:包括角色查看接口、角色创建接口、角色修改接口、删除角色接口;
角色组模块:包括角色组查看接口、角色组创建接口、角色组修改接口、删除角色组接口;
部门模块:包括部门查询列表接口、创建部门接口、修改部门接口、删除部门接口;
成员模块:包括成员查询列表接口、修改成员接口、启用成员接口、禁用成员接口;
应用模块:包括查询应用接口;
表单模块:包括查询单个表单接口;
记录模块:(表单数据模块):包括新增一条记录接口、查看单条记录详情接口、修改一条记录接口、删除记录接口;
文件模块:包括aliOss获取临时凭证接口、文件上传接口;
工作流模块 :包括工作流查询待办列表接口、工作流单条查询接口、工作流待办同意接口、工作流待办拒绝接口。
 

2. 使用教程

使用示例:通过第三方系统调用“新增一条记录接口”,触发英雄云表单新增一条记录。
 

2.1 获取API Key

API Key(应用程序接口密钥)是一种用于在客户端和服务器之间进行身份验证和授权的安全令牌。通过使用API Key,服务提供商可以验证请求的来源是否合法,并根据API Key的权限设置来限制或允许对特定资源的访问。
操作步骤:点击工作台左上角图标 → 点击“开放平台” → 点击【密钥管理】 → 点击“创建API Key”按钮。
复制API Key,作为第三方系统调用英雄云“新增一条记录接口”的身份验证和授权的安全令牌。

2.2 配置接口参数

根据英雄云提供的【记录模块】开发文档,在第三方系统配置调用接口参数。

接口地址:https://www.yingxiongyun.com/worksheet/api/v1/t/app/{applicationId}/form/{formId}/records

请求方式:POST

consumes:["application/json"]

produces:["*/*"]

接口描述:新增一条记录

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
applicationId 应用ID path true string  
formId 表单ID path true string  
body body body true 记录创建请求体 记录创建请求体

 

 schema属性说明

记录创建请求体:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
authGroupId 权限组ID body true string 默认:-1
fields 记录值 body false object  
formId 工作表ID body false string  

 

响应状态:

状态码 说明 schema
200 OK 响应结果对象«记录响应体»
201 Created  
401 Unauthorized  
403 Forbidden  
404 Not Found  

 

响应参数:

参数名称 参数说明 类型 schema
code 结果码 integer(int32) integer(int32)
data 结果数据 记录响应体 记录响应体
message 结果描述 string  
timestamp 时间戳 integer(int64) integer(int64)

 

schema属性说明

记录响应体:

参数名称 参数说明 类型 schema
fields 记录值 object  
id 记录ID string  
ownerBy 拥有者 object  

 

响应示例:

{
    "code": 0,
    "data": {
        "fields": {},
        "id": "",
        "ownerBy": {}
    },
    "message": "",
    "timestamp": 0
}

2.3 第三方发送请求

完成【2.2 配置接口参数】后即可在第三方系统触发请求。
 

2.4 查看API调用日志

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