api接口技术文档

一、基本说明 .......................................................................................................................................... 2 二、统一Form表单参数 ...................................................................................................................... 2 三、统一sign签名的生成规则 ............................................................................................................ 3

1、签名待加密字符串为key，timestamp，param组成的Json ......................................... 3 2、MD5签名规则 ......................................................................................................................... 3 四、统一返回Json格式 ....................................................................................................................... 3 五、部门接口 .......................................................................................................................................... 4

1、部门类ApiDept ....................................................................................................................... 4 2、Url和Param ............................................................................................................................. 5 3、调用示例 ................................................................................................................................... 6 六、人员接口 .......................................................................................................................................... 7

1、人员类ApiUser ....................................................................................................................... 7 2、Url和Param ............................................................................................................................. 8 3、调用示例 ................................................................................................................................... 9

1

一、基本说明

1、协议：http 2、请求方式：post

3、数据提交方式：Form表单提交 4、Accept：text/html

5、ContentType：application/x-www-form-urlencoded 6、返回格式：Json

二、统一Form表单参数

参数名称 是否必须 timestamp 是 时间戳.过期时间为30S,时间戳详见:https://tool.lu/timestamp/ param sign

说明 否 是

提交参数,Object[]的Json字符串 签名

2

三、统一sign签名的生成规则

1、签名待加密字符串为key，timestamp，param组成的Json Key timestamp param 如：

{\"key\":\"xxxxxx\2、MD5签名规则

32位加密,每个字节转化为大写16进制并且输出2位

Sting long Object[] 约定值：honggui 时间戳 可为null 四、统一返回Json格式

Succ Mes Ret

调用成功标志 调用失败返回信息 调用成功返回数据

3

五、部门接口

1、部门类ApiDept

名称 Id Name ParentId

类型 Int Sting Int 说明 自身Id 名字 父级Id 是否必须 是 是 否

4

2、Url和Param

Url http://XXXXXX/Service/Dept/All http://XXXXXX/Service/Dept/Single http://XXXXXX/Service/Dept/Insert http://XXXXXX/Service/Dept/Update

修改部门 新增部门 1、部门信息(ApiDept) 1、部门信息（ApiDept） 获取单个部门 1、Id(int) 说明 获取所有部门 Param 无

5

3、调用示例

接口名称 获取所有部门 请求参数示例 返回数据示例 获取单个部门 新增部门 修改部门

6

六、人员接口

1、人员类ApiUser

名称 Id LoginName 类型 Int String 说明 自身Id 系统登陆名(不可重复) ChineseName Phone IDnumber Bankname Bankcard DeptId

String String String String String Int? 中文名 电话 证件号码 银行名称 银行卡号 部门Id 是 是 否 否 否 否 是否必须 是 是

7

2、Url和Param

Url http://XXXXXX/Service/User/All http://XXXXXX/Service/User/Single http://XXXXXX/Service/User/Insert http://XXXXXX/Service/User/Update 说明 获取所有人员 Param 无 获取单个人员 1、Id(int) 新增人员 1、人员信息 （ApiUser） 修改人员 1、人员信息(ApiUser)

8

3、调用示例

接口名称 获取所有人员 请求参数示例 返回数据示例 获取单个人员 新增人员 修改人员

9