1. 业务目标

实现外部系统对本系统的授权及从本系统获取日志数据

2. 基本信息

2.1. 文档中用到的名词

外部系统：所有非本系统的其它系统

上层系统：上一级的管理系统或者云服务器

2.2. 双方约定

1. 请求由本系统发起，通过http协议与上层系统交互

2. 请求以post方式发送，数据为表单格式（以&连接的多个key=value名值对），即编码为application/x-www-form-urlencoded; charset=utf-8。请求数据中必须有data和md5两个参数。

a) 其中以data为key的参数表示请求数据，其值是json的格式字符串，使用utf8编码并urlencode的结果。Json数据格式由具体交互接口决定。

b) 其中以md5为key的值表示校验信息，其值为data的字符串值加上（连接）预先约定的密码字符串后经md5计算生成的32位小写字符串

3. 返回数据格式为json格式的字符串，以utf8编码

4. 本文的接口说明中，未指定类型的json数据默认数据类型为字符串

3. 接口说明

3.1. 拉取权限

3.1.1. 接口描述

系统主动向上级系统发起http请求，拉取指定标记后面生成的权限

3.1.2. 数据格式

ü 请求字段

名称	描述	类型	必须	示例值
start-rec-id	本次要获取的权限记录的开始位置，请求获取大于本参数值的权限记录，对应的值可能是外部系统权限数据表中的递增记录ID或者生成时间。空表示从头开始取数据。		是	“5”

请求数据范例：

{

“start-rec-id”: “”

}

 

ü 返回字段

返回结果

名称	描述	类型	必须	示例值
code	错误码，0成功，其它失败	int	是	0
message	操作结果信息		是	“/大学城校区/通信工程/电子3班“
max-rec-id	已经获取的最大id，下次获取以此为参数		是
records	权限详细信息列表

 

权限详细信息字段

名称	描述	类型	必须	示例值
rec-id	记录的标志		是	“1“
ssdw	所属组织，以/分隔的多级单位		是	“/大学城校区/通信工程/电子3班“
state	组织状态
link	人员关系类型		是	“内部人员“
nbr	编号		是	“201800102358“
name	姓名		是	“张三“
sex	性别
kind	民族
idno	身份证号码
address	证件地址
birthday	出生年月
appoint	职务
office	办公位置
phone	电话号码
mobile	手机号码
car	车牌号
card	员工卡号		是	“1234567890“
cardalias	卡自编号
role	角色		是	“学生“
memo	备注
org1	一级组织
org2	二级组织
org3	三级组织
org4	四级组织
buildstate	组建状态

返回数据范例：

{

“code”:0,

“message”:”操作成功”,

“max-rec-id”:”2”,

”records”: [

{

“rec-id”: “1”,

“ssdw”: “/计算机学院/计算机专业”,

“link”: “学生”,

“nbr”: “2018001003013“,

“name”: “张三“,

“card”: “1234567890”,

“role”: “学生”

},

{

“rec-id”: “2”,

“ssdw”: “/计算机学院/计算机专业”,

“link”: “学生”,

“nbr”: “2018001003014“,

“name”: “李四“,

“card”: “2312362234”,

“role”: “学生”

}

]

}

3.1.3. 补充说明

无

3.2. 日志上传

3.2.1. 接口描述

系统主动向上级系统发起http请求，按生成时间依次上报刷卡记录。返回成功则继续上报新的数据，否则重复上报未成功记录。

3.2.2. 数据格式

ü 请求字段

名称	描述	类型	必须	示例值	默认值
rec-id	记录标志		是	“5”
ssdw	所属组织，以/分隔的多级单位		是	/大学城校区/通信工程/电子3班
link	人员关系类型		是	内部人员
nbr	编号		是	201800102358
name	姓名		是	张三
card	刷卡凭证号		是	1234567890
time	刷卡时间		是	“2018-03-26 13:24:32”
devid	设备标志		是	“33254”
devname	设备名称		是	“大门2通道”
Image	抓拍图片base64结果，没有则为空

 

请求数据范例：

{

“rec-id”: “5”,

“ssdw”: “/大学城校区/通信工程/电子3班”,

“link”: “学生”,

“nbr”: “2018001003013“, 

“name”: “王五”,

“card”: “330XXXXXXXXXX,

“time”: “2014-01-01 00:00:00”,

“devid”: “33254”,

“devname”: “大门2通道”,

“image”:” 5L2Z5pel56WlMTky5rWL6K+V5LqM57u056CB5YWl6Zeo…”,

}

ü 返回字段

名称	描述	类型	必须	示例值
code	错误码，0成功，其它失败	int	是	0
message	操作结果信息		是	“/大学城校区/通信工程/电子3班“
max-rec-id	已经获取的最大id，下次获取以此为参数		是
records	权限详细信息列表

 

返回数据范例：

{

“code”:0,

“message”:”操作成功”,

}

1.1.1. 补充说明

无