厦门大学实验室资源信息管理系统接口说明Word文档格式.docx
《厦门大学实验室资源信息管理系统接口说明Word文档格式.docx》由会员分享，可在线阅读，更多相关《厦门大学实验室资源信息管理系统接口说明Word文档格式.docx（28页珍藏版）》请在冰豆网上搜索。
状态码
仪器数据推送结果：
100
代表成功
101
代表数据存取成功，并根据结果
2.2.2
请求消息参数描述
页面的地址（url）String否仪器预约页面的
url
2.1.4
接口流程
（1）校级系统发布预约仪器服务；
（2）用户点击预约按钮，接口将用户的预约请求（仪器所属单位内部编码
innerID
及单位唯一标识）送至相应的院级系统；
（3）院级系统接收到校级平台推送的预约请求，通过在线平台的预约审核
流程对预约请求进行审核，根据审核结果并返回具体的仪器预约页面；
（4）用户可以在院级系统返回的预约页面中进行仪器预约操作。
2.1.5
注意事项
（1）校级平台统一分配院级单位的唯一标识；
（2）校级平台不提供仪器预约服务，只能将用户预约请求推送至院级系统，
由院级系统提供具体的仪器预约服务；
（3）院级系统返回给校级平台的是具体的仪器与预约页面
url，而不是院
级系统的首页或其他页面，并且确保预约页面能打开；
（4）院级系统返回的预约页面中必须包括该仪器的开放日历及机时安排情
况；
2.2
2.2.1
院级系统获取校级平台仪器数据的接口。
提示信息
200
代表单位编码错误
201
代表填报数据类型错误
202
代表推送的数据
json
字符串格式
错误
203
代表验证数据格式错误
204
代表其他异常
301
代表数据库操作异常
仪器数据集合
List<
String>
见
2.2.3
返回示例说明
{"
status"
:
100,
"
list"
[
{
CollegeName"
xxxx"
//学院名称
UnitNumber"
2J02"
//单位号
SASACClassificationNum"
2400502"
//国资分类号
InstrumentChineseName"
//仪器名称（中文）
InstrumentClassificationNumber"
03052207"
//仪器分类号
Model"
MCR302"
//型号
Specifications"
//规格
UnitPrice"
597916.07"
//单价
DateOfProduction"
2013\/12\/6
0:
00:
00"
//出厂日期
PurchaseDate"
//购置日期
StorageTime"
2014\/11\/25
//入库时间
CountryOfOrigin"
//生产国别
CountryCode"
156"
//国别码
Manufacturer"
//生产厂家
}
]
是否必填
参数说明
示例参考
isCourtyardNew
是
是否院级新增仪器
0
为否
为
CollegeName
学院名称
UnitNumber
单位号
SASACClassificationNum
国资分类号
InstrumentChineseName
仪器名称（中文）
InstrumentClassificationNumber
仪器分类号
Model
型号
Specifications
规格
UnitPrice
单价
DateOfProduction
出厂日期
PurchaseDate
购置日期
StorageTime
入库时间
CountryOfOrigin
生产国别
见仪器数据集合字段说明
2.3
2.3.1
院级系统上报校级平台仪器数据的接口。
仪器数据集合字段说明
CountryCode
国别码
Manufacturer
生产厂家
InstrumentSharingCode
仪器共享分类编码
FundsNardNumber
经费卡号
MainTechnicalIndex
主要技术指标
MajorFundingSources
主要经费来源
MainTestResearchArea
主要测试研究领域与代码
FunctionalFeatures
功能特色
SharedMode
共享模式
OneYearOffCampusOpen
一年内可用于对校外开放
机时
MeasurementCertification
是否通过计量认证
PlacePosition
放置位置
InstrumentImage
仪器图片
InstrumentResponsiblePerson
仪器负责人
InstrumentResponsiblePersonTel
仪器负责人联系电话
InstrumentResponsiblePersonMail
仪器负责人电子邮箱
InstrumentEinglishName
仪器名称（英文）
2.3.3
响应消息参数描述
院级系统的唯一标识
使用记录的集合
详见使用记录的集合字段说明
2.3.4
（1）校级平台发布仪器数据报送服务；
（2）院级系统通过该接口推送仪器数据至校级平台；
（3）校级平台验证单位唯一标识和仪器类别的正确性；
验证失败则返回相
应状态码；
（4）校级平台对上报的仪器数据进行验证，验证通过进行数据库存储，已
报过的数据则进行更新；
验证失败返回相应状态码；
2.2.5
（1）院级系统通过接口报送的数据格式按照附录
中仪器数据报送接口的
各类型仪器示例。
（2）校级平台统一分配院级单位的唯一标识；
院级单位可登录校级平台查
看本单位的唯一标识，院级系统需保存单位标识关联表；
（3）管理单位院级系统需将平台负责人的通讯邮箱上报校级平台；
校级平
台对数据验证的错误信息会以邮件的方式发送院级系统负责人的邮箱；
（4）院级系统接与校级平台的对接过程中，如果多次出现错误状态码，及
时联系相关人员。
2.4
仪器使用记录接口
2.4.1
院级系统将仪器使用记录数据上报到校级平台的接口。
使用记录的集合字段说明
参数名称是否必填参数说明示例参考
AppointmentStart
预约时间（起）
2013/12/6
00
AppointmentEnd
预约时间（止）
AppointmentLength
预约时长
ControllerRecordSta
rt
控制器记录时间（起）
ControllerRecordEn
d
控制器记录时间（止）
ControllerRecordLe
ngth
控制器记录的实际测试时长
SampleNumber
样品个数
SendSampleName
预约或送样人姓名
SendSampleNumbe
r
预约或送样人教工号（学工号）
SendSampleGroup
预约或送样人所属课题组
SendSampleGroupH
ead
预约或送样人所属课题组负责
人
CardPersonName
刷卡人姓名
CardPersonNumber
刷卡人教工号（学工号）
CardPersonGroup
刷卡人所属课题组
OrderItemName
预约检测项目名称
SendSampleItemNa
me
送样检测项目名称
服务成效数据推送结果：
代表数据验证错误
2.4.3
2.4.4
（1）校级贵重仪器设备管理系统根据从各学院抓取的仪器设备使用情况数
据作为计费数量的依据；
（2）院级系统调用该接口将单位的仪器设备使用情况数据推送至校级平台；
（3）校级平台首先验证单位唯一标识的正确性，验证通过则获取仪器设备
使用情况数据；
验证失败则返回相应的状态码；
（4）校级平台将上报的仪器设备使用情况数据进行验证，验证通过则保存
到数据库中，验证失败则返回相应的状态码；
2.3.5
（1）院级系统通过该接口报送的仪器设备使用情况数据按照附录
中的仪
器使用记录接口的示例。
院级系统需保存单位标识关
联表；
院级单位可登录校级平台查看本单位的唯一标识；
（3）院级系统需将平台负责人的通讯邮箱地址上报校级平台；
校级平台对
数据的验证错误信息会以邮件的方式发送院级系统负责人的邮箱；
（4）院级系统接与校级平台的对接过程中，如果多次出现错误的状态码，
需联系相关人员。
2.5
校级平台提供用户信息接口，用于院级系统与校级平台的用户统一认证和
管理。
具体详情见
Oauth
说明文档。
对接用户认证开发指南
一、
Oauth2.0
授权访问流程
OAuth客户端OAuth服务器
重定向用户到authorize
接口
生成authorize_code，
重定向用户到
redirect_uri
使用authorize_code向
access_token接口发起
请求
生成access_token，并
返回
使用access_token向
resource接口发起请求
返回用户信息
获取用户信息
（1）
管理单位网站重定向用户到校级平台提供的
authorize
接口，如果用户同意授权，
校级平台会把用户重定向回到院级单位网站，并附上授权码
authorize_code；
（2）
校级单位网站使用
authorize_code
向校级平台的
access_token
接口发起请求，
校级平台在验证请求合法后，会返回访问令牌
access_token；
（3）
向
resource
接口发起请求，获取用户信息。
二、
单位平台工作流程
1.用户在校级平台发起“预约仪器”请求，校级平台将请求重定向到院级平台。
2.院级平台检查用户登录状态，若是登录状态，则直接转到仪器预约页面；
若处于未登
录状态，则转到步骤
3
代表的登录页面。
3.单位平台的登录页面中要有“使用校级平台账号登录”入口。
4.若用户选择直接使用院级平台账号登录，则登陆后转到仪器预约页面；
若用户选择“使
参数
必选
类型及范围
说明
client_id
true
string
注册应用时分配的
ID
response_typ
e
返回类型，固定为
code
授权回调地址，需与注册时设置的回
调地址一致
scope
申请
scope
权限所需参数，只提供
read
一种
state
用于保持请求和回调的状态，在回调
时，会回传该参数。
开发者可以用这
个参数验证请求有效性，也可以记录
用户请求授权页前的位置。
这个参数
可用于防止跨站请求伪造（CSRF）攻
击
返回值字段
字段类型
字段说明
用于调用
接
口，获取授权后的
access
token
如果传递参数，会回传该
用校级平台账号登录”，则开始
oauth2.0
授权认证过程。
5.重定向用户到校级平台
接口，请求
authorize_code。
校级平台
访问标准如下：
1）
URL
https:
//mainplatform/oauth2/authorize
2）
HTTP
请求方式
GET/POST
3）
请求参数
4）
返回数据
5）
示例：
请求：
//mainplatform/oauth2/authorize?
client_id=CLIENT_ID&
redirect_uri=http:
//subplatf
orm/response&
response_type=code&
scope=read&
state=STATE
同意授权后会重定向用户到：
http:
//subplatform/response?
state=STATE&
code=CODE
6.院级平台获得
authorize_code,访问校级平台的
access_token。
接口访问标准如下：
//mainplatform/oauth2/access_token
client_secre
t
secret
grant_type
请求的类型，填写
authorization_code
调用
获得的
code
值
回调地址，需与注册应用里的回调地
址一致
access_token
用于调用资源访问接口，
获取用户数据
expires_in
的生命周期，
单位是秒数
获得的
RESOURCE_NAM
E
ture
访问资源的名称
POST
//mainplatform/oauth2/access_token?
client_secret=CLIENT_S
ECRET&
grant_type=authorization_code&
code=CODE&
//subplatform/res
ponse
成功获取后返回数据：
access_token"
ACCESS_TOKEN"
expires_in"
1234,
7.获得校级平台返回的
access_token,访问校级平台
接口，请求用户信息。
校级
平台的
//mainplatform/oauth2/resource/RESOURCE_NAME
GET
字符串
资源键值对
//mainplatform/oauth2/resource/userinfo?
access_token=ACCESS_TOKEN
返回数据：
username
USERNAME"
email"
EMAIL"
8.院级系统获得用户信息。
9.院级系统本地应有一个数据库表（新建数据库表或者修改原有数据表，后文用”关联表
“代替），用来维持着院级系统账号与校级平台账号的关联关系，保证在获得用户信息
后，通过查询关联表，可以获知该用户是否已经进行过关联操作，若查询结果为该用
户已经进行过关联，则登录对应的院级系统账号，并转到仪器预约页面；
若该用户未
进行过关联，进入步骤
10。
10.
询问用户是否将校级平台账号关联到已有院级系统账号，若用户选择是则将用户已有
院级系统账号与校级平台账号加入关联表；
若用户选择否则转到注册页面，该页面利
用已经获得的用户信息自动填充相关注册项目，注册用户院级系统账号（注册流程同
院级系统正常注册流程），并将账号关联信息加入关联表。
升级会员 