厦门大学实验室资源信息管理系统接口说明文档

厦门大学实验室资源信息管理系统接口说明文档1系统概述厦门大学实验室资源信息管理系统，以下简称“校级平台”，各院级实验仪器管理系统，以下简称“院级系统”。管理单位可以按照统一的数据标准及格式规范，通过接口的方式将报送数据至校级平台。本接口采用REST接口方式，提交与返回的数据为JSON格式，以实现校级平台与各院级系统在数据与服务方面的对接，更加有效地开展实验室资源信息管理服务。本规范适用于各院级系统。校级平台与院级系统共涉及4个接口，具体如下：接口名称用途预约请求接口接收校级平台推送的用户预约请求，返回仪器预约页面仪器数据获取接口接收校级平台推送的仪器信息仪器数据报送接口接收院级系统向校级平台推送仪器信息使用记录上报接口接收院级系统向校级平台推送仪器使用记录接口用户信息接口用于院级系统与校级用户统一认证和管理2接口说明2.1预约请求接口2.1.1接口描述：校级平台通过该接口将预约请求推至院级系统，获取相应院级系统返回的仪器预约页面。2.1.2请求消息参数描述参数名称类型是否为空描述innerIDString否仪器所属单位内部的唯一编码；insCodeString否管理单位的唯一标识；2.1.3响应消息参数描述参数名称类型是否为空描述页面的地址（url）String否仪器预约页面的url2.1.4接口流程（1） 校级系统发布预约仪器服务；（2） 用户点击预约按钮，接口将用户的预约请求（仪器所属单位内部编码innerID及单位唯一标识）送至相应的院级系统；（3） 院级系统接收到校级平台推送的预约请求，通过在线平台的预约审核流程对预约请求进行审核，根据审核结果并返回具体的仪器预约页面；（4） 用户可以在院级系统返回的预约页面中进行仪器预约操作。2.1.5注意事项（1） 校级平台统一分配院级单位的唯一标识；（2） 校级平台不提供仪器预约服务，只能将用户预约请求推送至院级系统，由院级系统提供具体的仪器预约服务；（3） 院级系统返回给校级平台的是具体的仪器与预约页面url，而不是院级系统的首页或其他页面，并且确保预约页面能打开；（4） 院级系统返回的预约页面中必须包括该仪器的开放日历及机时安排情况；2.2仪器数据获取接口2.2.1接口描述：院级系统获取校级平台仪器数据的接口。2.2.2请求消息参数描述参数名称类型是否为空描述insCodeString否院级单位的唯一标识instruTypeint否填报数据类型：9 仪器信息2.2.3响应消息参数描述参数名称类型是否为空描述状态码int否仪器数据推送结果：100代表成功101代表数据存取成功，并根据结果提示信息200代表单位编码错误201代表填报数据类型错误202代表推送的数据json字符串格式错误203代表验证数据格式错误204代表其他异常301代表数据库操作异常仪器数据集合List否见2.2.3返回示例说明2.2.3返回示例说明status:100,list:CollegeName:xxxx,/学院名称UnitNumber:2J02,/单位号SASACClassificationNum:,/国资分类号InstrumentChineseName:xxxx,/仪器名称(中文)InstrumentClassificationNumber:,/仪器分类号Model:MCR302,/型号Specifications:MCR302,/规格UnitPrice:.07,/单价DateOfProduction:2013/12/6 0:00:00,/出厂日期PurchaseDate:2013/12/6 0:00:00,/购置日期StorageTime:2014/11/25 0:00:00,/入库时间CountryOfOrigin:xxxx,/生产国别CountryCode:156,/国别码Manufacturer:xxxx/生产厂家2.3仪器数据报送接口2.3.1接口描述：院级系统上报校级平台仪器数据的接口。2.3.2请求消息参数描述参数名称类型是否为空描述insCodeString否院级单位的唯一标识instruTypeint否填报数据类型：9 仪器信息仪器数据集合List否见仪器数据集合字段说明仪器数据集合字段说明参数名称是否必填参数说明示例参考isCourtyardNew是是否院级新增仪器0为否 1为是CollegeName是学院名称UnitNumber是单位号SASACClassificationNum是国资分类号InstrumentChineseName是仪器名称（中文）InstrumentClassificationNumber是仪器分类号Model是型号Specifications是规格UnitPrice是单价DateOfProduction是出厂日期PurchaseDate是购置日期StorageTime是入库时间CountryOfOrigin是生产国别CountryCode是国别码Manufacturer是生产厂家InstrumentSharingCode是仪器共享分类编码FundsNardNumber是经费卡号MainTechnicalIndex是主要技术指标MajorFundingSources是主要经费来源MainTestResearchArea是主要测试研究领域与代码FunctionalFeatures是功能特色SharedMode是共享模式OneYearOffCampusOpen是一年内可用于对校外开放机时MeasurementCertification是是否通过计量认证PlacePosition是放置位置InstrumentImage是仪器图片InstrumentResponsiblePerson是仪器负责人InstrumentResponsiblePersonTel是仪器负责人联系电话InstrumentResponsiblePersonMail是仪器负责人电子邮箱InstrumentEinglishName否仪器名称(英文)2.3.3响应消息参数描述参数名称类型是否为空描述状态码int否仪器数据推送结果：100代表成功101代表数据存取成功，并根据结果提示信息200代表单位编码错误201代表填报数据类型错误202代表推送的数据json字符串格式错误203代表验证数据格式错误204代表其他异常301代表数据库操作异常2.3.4接口流程（1） 校级平台发布仪器数据报送服务；（2） 院级系统通过该接口推送仪器数据至校级平台；（3） 校级平台验证单位唯一标识和仪器类别的正确性；验证失败则返回相应状态码；（4） 校级平台对上报的仪器数据进行验证，验证通过进行数据库存储，已报过的数据则进行更新；验证失败返回相应状态码；2.2.5注意事项（1） 院级系统通过接口报送的数据格式按照附录1中仪器数据报送接口的各类型仪器示例。（2） 校级平台统一分配院级单位的唯一标识；院级单位可登录校级平台查看本单位的唯一标识，院级系统需保存单位标识关联表；（3） 管理单位院级系统需将平台负责人的通讯邮箱上报校级平台；校级平台对数据验证的错误信息会以邮件的方式发送院级系统负责人的邮箱；（4） 院级系统接与校级平台的对接过程中，如果多次出现错误状态码，及时联系相关人员。2.4仪器使用记录接口2.4.1接口描述：院级系统将仪器使用记录数据上报到校级平台的接口。2.4.2请求消息参数描述参数名称类型是否为空描述insCodeString否院级系统的唯一标识使用记录的集合List否详见使用记录的集合字段说明使用记录的集合字段说明参数名称是否必填参数说明示例参考AppointmentStart是预约时间（起）2013/12/6 0:00:00AppointmentEnd是预约时间（止）2013/12/6 0:00:00AppointmentLength是预约时长ControllerRecordStart是控制器记录时间（起）2013/12/6 0:00:00ControllerRecordEnd是控制器记录时间（止）2013/12/6 0:00:00ControllerRecordLength是控制器记录的实际测试时长SampleNumber否样品个数SendSampleName是预约或送样人姓名SendSampleNumber是预约或送样人教工号（学工号）SendSampleGroup是预约或送样人所属课题组SendSampleGroupHead是预约或送样人所属课题组负责人CardPersonName是刷卡人姓名CardPersonNumber是刷卡人教工号（学工号）CardPersonGroup是刷卡人所属课题组OrderItemName否预约检测项目名称SendSampleItemName否送样检测项目名称2.4.3响应消息参数描述参数名称类型是否为空描述状态码int否服务成效数据推送结果：100代表成功200代表单位编码错误201代表推送的数据json字符串格式错误202代表数据验证错误203代表其他异常301代表数据库操作异常2.4.4接口流程（1） 校级贵重仪器设备管理系统根据从各学院抓取的仪器设备使用情况数据作为计费数量的依据；（2） 院级系统调用该接口将单位的仪器设备使用情况数据推送至校级平台；（3） 校级平台首先验证单位唯一标识的正确性，验证通过则获取仪器设备使用情况数据；验证失败则返回相应的状态码；（4） 校级平台将上报的仪器设备使用情况数据进行验证，验证通过则保存到数据库中，验证失败则返回相应的状态码；2.3.5注意事项（1） 院级系统通过该接口报送的仪器设备使用情况数据按照附录1中的仪器使用记录接口的示例。（2） 校级平台统一分配院级单位的唯一标识；院级系统需保存单位标识关联表；院级单位可登录校级平台查看本单位的唯一标识；（3） 院级系统需将平台负责人的通讯邮箱地址上报校级平台；校级平台对数据的验证错误信息会以邮件的方式发送院级系统负责人的邮箱；（4） 院级系统接与校级平台的对接过程中，如果多次出现错误的状态码，需联系相关人员。2.5用户信息接口校级平台提供用户信息接口，用于院级系统与校级平台的用户统一认证和管理。具体详情见Oauth说明文档。对接用户认证开发指南一、 Oauth2.0授权访问流程（1） 管理单位网站重定向用户到校级平台提供的authorize接口，如果用户同意授权，校级平台会把用户重定向回到院级单位网站，并附上授权码authorize_code；（2） 校级单位网站使用authorize_code向校级平台的access_token接口发起请求，校级平台在验证请求合法后，会返回访问令牌access_token；（3） 校级单位网站使用access_token向resource接口发起请求，获取用户信息。二、 单位平台工作流程1. 用户在校级平台发起“预约仪器”请求，校级平台将请求重定向到院级平台。2. 院级平台检查用户登录状态，若是登录状态，则直接转到仪器预约页面；若处于未登录状态，则转到步骤3代表的登录页面。3. 单位平台的登录页面中要有“使用校级平台账号登录”入口。4. 若用户选择直接使用院级平台账号登录，则登陆后转到仪器预约页面；若用户选择“使用校级平台账号登录”，则开始oauth2.0授权认证过程。5. 重定向用户到校级平台authorize接口，请求authorize_code。校级平台authorize接口访问标准如下：1) URLhttps:/mainplatform/oauth2/authorize2) HTTP请求方式GET/POST3) 请求参数参数必选类型及范围说明client_idtruestring注册应用时分配的IDresponse_typetruestring返回类型，固定为coderedirect_uritruestring授权回调地址，需与注册时设置的回调地址一致scopetruestring申请scope权限所需参数，只提供read一种statetruestring用于保持请求和回调的状态，在回调时，会回传该参数。开发者可以用这个参数验证请求有效性，也可以记录用户请求授权页前的位置。这个参数可用于防止跨站请求伪造（CSRF）攻击4) 返回数据返回值字段字段类型字段说明codestring用于调用access_token接口，获取授权后的access tokenstatestring如果传递参数，会回传该参数5) 示例：请求：https:/mainplatform/oauth2/authorize?client_id=CLIENT_ID&redirect_uri=http:/subplatform/response&response_type=code&scope=read&state=STATE同意授权后会重定向用户到：http:/subplatform/response?state=STATE&code=CODE6. 院级平台获得authorize_code,访问校级平台的access_token接口，请求access_token。校级平台access_token接口访问标准如下：1) URLhttps:/mainplatform/oauth2/access_token2) HTTP请求方式POST3) 请求参数参数必选类型及范围说明client_idtruestring注册应用时分配的IDclient_secrettruestring注册应用时分配的secretgrant_typetruestring请求的类型，填写authorization_codecodetruestring调用authorize获得的code值redirect_uritruestring回调地址，需与注册应用里的回调地址一致4) 返回数据返回值字段字段类型字段说明access_tokenstring用于调用资源访问接口，获取用户数据expires_instringaccess_token的生命周期，单位是秒数5) 示例请求：https:/mainplatform/oauth2/access_token?client_id=CLIENT_ID&client_secret=CLIENT_SECRET&grant_type=authorization_code&code=CODE&redirect_uri=http:/subplatform/response成功获取后返回数据： access_token: ACCESS_TOKEN, expires_in: 1234,7. 获得校级平台返回的access_token,访问校级平台resource接口，请