OpenAPI接口使用说明

来自企业管理软件文档中心
跳转至: 导航搜索

云表支持通过OpenAPI方式让云表对接外部应用,这需要用户具备一定的开发能力。

一、鉴权方式

1.1 名词解释

AppKey:云表平台分配给每个应用空间的 AppKey,使用进行生成 Sign(签名)

AppName:云表平台分配给每个应用空间的 AppName,用户需要进行保密,是需要传递给后台服务器进行验证签名是否正确合法.

AppId:应用空间 ID,每个应用空间将会有一个唯一 ID,云表平台负责分配.

Sign:签名,每次访问服务器端都需要进行签名验证.

Timestamp:时间戳,每次访问服务器,必须将当前时间戳传递给服务器,6 分钟内的访问是有效的.


1.2 申请 AppKey,AppName 方式

申请地址:“我的系统”-“系统管理”-“系统服务”-“第三方应用授权”

新建一个第三方应用授权,配置应用名称后将获取到 appName,appKey。

Openapi申请Appkey.jpg
 


1.3 签名生成

生成签名的方式为,使用云表提供的 AppKey 与当前访问时间戳进行 MD5 32 位加密,Sign = ( AppKey + 时间戳 ) MD5加密 转成大写.。

例如:

AppKey = 058457b7-0e4a-4f6c-b7f4-10d56689f036

Timestamp = 1389085779854

合成 Sign = ((1389085779854058457b7-0e4a-4f6c-b7f4-10d56689f036)MD5)转大写

最后合成值为:F3DFAE8C1B952779ED068B9DB66BE258


二、服务器接口访问

2.1 请求格式

Open Api 链接服务器的所有接口,可以自行选择使用HTTP或者HTTPS 协议,并且在 head 中传递服务器所需的参数。

参数列表:

x-eversheet-request-sign: 访问签名与时间戳一起传递使用,进行分割

例如:

x-eversheet-request-sign = F3DFAE8C1B952779ED068B9DB66BE258,1389085779854。

x-eversheet-application-name:传递给服务器进行匹配签名。

x-eversheet-session-token:临时令牌,当登入成功后服务器将会生成一个临时令牌供客户使用.如果进行登入,值为空

三、已支持的接口

目前云表支持下列接口,接口详情请查看在线文档:

文档地址:云表OpenAPI在线文档


OpenAPI列表.png
 

1、登入请求

2、登出请求

3、打开表单总表接口

4、总表表单过滤

5、打开表单接口

6、提交保存表单接口

7、删除表单

8、打开用户总表

9、打开用户表单

10、更新用户对象

11、打开角色总表

12、打开指定角色对象

13、更新角色对象

14、使用全局数据规范

15、使用指定模板数据规范

16、方位参数调用全局数据接口

17、上传附件接口

18、下载附件接口

19、发送短信

OpenAPI依赖库下载

点击下载:OpenApi接口及文档-0.0.7.9.zip

OpenApi使用的库.png