厦门大学室资源信息管理系统

1、厦门大学实验室资源信息管理系统接口说明文档系统归纳厦门大学实验室资源信息管理系统,以下简称“校级平台，各院级实验仪器管理系统，以下简称“院级系统”.管理单位可以依照一致的数据标准及格式规范，经过接口的方式将报送数据至校级平台.本接口采用REST接口方式，提交与返回的数据为JSON格式，以实现校级平台与各院级系统在数据与服务方面的对接，更加有效地睁开实验室资源信息管理服务。本规范适用于各院级系统.校级平台与院级系统共涉及4个接口,详尽以下：接口名称用途预约央求接口接收校级平台推送的用户预约央求，返回仪器预约页面仪器数据获得接口接收校级平台推送的仪器信息仪器数据报送接口接收院级系统向校级平台推送仪

2、器信息使用记录上报接口接收院级系统向校级平台推送仪器使用记录接口用户信息接口用于院级系统与校级用户一致认证和管理接口说明2.1预约央求接口2.1.1接口描述：校级平台经过该接口将预约央求推至院级系统，获得相应院级系统返回的仪器预约页面.2.1.2央求信息参数描述参数名称种类可否为空描述innerIDString否仪器所属单位内部的唯一编码；insCodeString否管理单位的唯一表记;2.1。3响应信息参数描述参数名称种类可否为空描述1页面的地址（url）String否仪器预约页面的url2.1。4接口流程（1）校级系统宣布预约仪器服务；（2）用户点击预约按钮,接口将用户的预约央求（仪器所属

3、单位内部编码innerID及单位唯一表记）送至相应的院级系统；（3）院级系统接收到校级平台推送的预约央求，经过在线平台的预约审察流程对预约央求进行审察，依照审察结果并返回详尽的仪器预约页面;（4）用户可以在院级系统返回的预约页面中进行仪器预约操作.2.1.5注意事项（1）校级平台一致分配院级单位的唯一表记；（2）校级平台不供应仪器预约服务，只能将用户预约央求推送至院级系统，由院级系统供应详尽的仪器预约服务；（3）院级系统返回给校级平台的是详尽的仪器与预约页面url，而不是院级系统的首页或其他页面,并且保证预约页面能打开；（4）院级系统返回的预约页面中必定包括该仪器的开放日历及机时安排情况;2。

4、2仪器数据获得接口2。2。1接口描述：院级系统获得校级平台仪器数据的接口。2。2.2央求信息参数描述参数名称种类可否为空描述insCodeString否院级单位的唯一表记instruTypeint否填报数据种类：9仪器信息2。2。3响应信息参数描述参数名称种类可否为空描述状态码int否仪器数据推送结果：100代表成功101代表数据存取成功，并依照结果提2示信息200代表单位编码错误201代表填报数据种类错误202代表推送的数据json字符串格式错误203代表考据数据格式错误204代表其他异常301代表数据库操作异常仪器数据会集ListString否见2。2.3返回示例说明2.2.3返回示例说明

5、”status：100,list:CollegeName”：xxxx,/学院名称”UnitNumber”:2J02，/单位号SASACClassificationNum：”2400502，/国资分类号”InstrumentChineseName:”xxxx，/仪器名称(中文）”InstrumentClassificationNumber”：03052207,/仪器分类号Model”:MCR302”，/型号”Specifications”：MCR302”,/规格”UnitPrice”:597916。07,/单价”DateOfProduction：2013/12/60：00:00，/出厂日期Pur

6、chaseDate”:”2013/12/60：00:00”，/购置日期StorageTime：2014/11/250:00:00，/入库时间”CountryOfOrigin”：”xxxx，/生产国别CountryCode”:”156,/国别码Manufacturer”：”xxxx/生产厂家32.3仪器数据报送接口2.3。1接口描述:院级系统上报校级平台仪器数据的接口。2.3.2央求信息参数描述参数名称种类可否为空描述insCodeString否院级单位的唯一表记instruTypeint否填报数据种类：9仪器信息仪器数据会集ListString否见仪器数据会集字段说明仪器数据会集字段说明参数名

7、称isCourtyardNewCollegeNameUnitNumberSASACClassificationNumInstrumentChineseNameInstrumentClassificationNumberModelSpecificationsUnitPriceDateOfProductionPurchaseDateStorageTimeCountryOfOrigin可否必填是是是是是是是是是是是是是参数说明示例参照可否院级新增仪器0为否1为是学院名称单位号国资分类号仪器名称（中文）仪器分类号型号规格单价出厂日期购置日期入库时间生产国别4CountryCode国别码是Manufac

8、turerInstrumentSharingCodeFundsNardNumberMainTechnicalIndexMajorFundingSourcesMainTestResearchAreaFunctionalFeaturesSharedMode是是是是是是是是生产厂家仪器共享分类编码经费卡号主要技术指标主要经费本源主要测试研究领域与代码功能特色共享模式OneYearOffCampusOpenMeasurementCertification一年内可用于对校外开放是机时可否经过计量认证是PlacePositionInstrumentImage是是放置地址仪器图片InstrumentResp

9、onsiblePerson仪器负责人是InstrumentResponsiblePersonTelInstrumentResponsiblePersonMailInstrumentEinglishName2。3。3响应信息参数描述是是否仪器负责人联系电话仪器负责人电子邮箱仪器名称(英文）参数名称种类状态码int可否为空描述否仪器数据推送结果：100代表成功101代表数据存取成功，并依照结果提示信息200代表单位编码错误201代表填报数据种类错误202代表推送的数据json字符串格式5错误203代表考据数据格式错误204代表其他异常301代表数据库操作异常2.3。4接口流程（1）校级平台宣布仪器

10、数据报送服务；（2）院级系统经过该接口推送仪器数据至校级平台；（3）校级平台考据单位唯一表记和仪器类其他正确性；考据失败则返回相应状态码；（4）校级平台对上报的仪器数据进行考据，考据经过进行数据库储藏，已报过的数据则进行更新；考据失败返回相应状态码;2.2.5注意事项（1）院级系统经过接口报送的数据格式依照附录1中仪器数据报送接口的各样类仪器示例。（2）校级平台一致分配院级单位的唯一表记；院级单位可登录校级平台查看本单位的唯一表记，院级系统需保存单位表记关系表；（3）管理单位院级系统需将平台负责人的通讯邮箱上报校级平台;校级平台对数据考据的错误信息会以邮件的方式发送院级系统负责人的邮箱；（4）

11、院级系统接与校级平台的对接过程中，若是多次出现错误状态码，及时联系相关人员。2.4仪器使用记录接口2.4.1接口描述：院级系统将仪器使用记录数据上报到校级平台的接口.2.4.2央求信息参数描述参数名称种类可否为空描述insCodeString否院级系统的唯一表记使用记录的会集ListString否详见使用记录的会集字段说明使用记录的会集字段说明参数名称可否必填参数说明示例参照6AppointmentStart预准时间(起)是2013/12/60:00:00AppointmentEndAppointmentLengthControllerRecordStartControllerRecordEn

12、dControllerRecordLengthSampleNumberSendSampleNameSendSampleNumberSendSampleGroup是是是是是否是是是预准时间（止）预准时长控制器记录时间（起)控制器记录时间（止）控制器记录的实质测试时长样品个数预约或送样人姓名预约或送样人教工号（学工号)预约或送样人所属课题组2013/12/60：00:002013/12/60:00：002013/12/60：00:00SendSampleGroupHeadCardPersonNameCardPersonNumber预约或送样人所属课题组负责是人刷卡人姓名是刷卡人教工号(学工号）是C

13、ardPersonGroupOrderItemNameSendSampleItemName是否否刷卡人所属课题组预约检测项目名称送样检测项目名称2。4。3响应信息参数描述参数名称种类可否为空描述状态码int否服务见效数据推送结果：100代表成功200代表单位编码错误201代表推送的数据json字符串格式错误202代表数据考据错误203代表其他异常301代表数据库操作异常72.4。4接口流程（1）校级名贵仪器设备管理系统依照从各学院抓取的仪器设备使用情况数据作为计费数量的依照;（2）院级系统调用该接口将单位的仪器设备使用情况数据推送至校级平台；（3）校级平台第一考据单位唯一表记的正确性，考据经过

14、则获得仪器设备使用情况数据；考据失败则返回相应的状态码；（4）校级平台将上报的仪器设备使用情况数据进行考据，考据经过则保存到数据库中,考据失败则返回相应的状态码；2。3.5注意事项（1）院级系统经过该接口报送的仪器设备使用情况数据依照附录1中的仪器使用记录接口的示例。（2）校级平台一致分配院级单位的唯一表记；院级系统需保存单位表记关联表；院级单位可登录校级平台查察本单位的唯一表记；（3）院级系统需将平台负责人的通讯邮箱地址上报校级平台；校级平台对数据的考据错误信息会以邮件的方式发送院级系统负责人的邮箱;（4）院级系统接与校级平台的对接过程中，若是多次出现错误的状态码，需联系相关人员.2.5用户

15、信息接口校级平台供应用户信息接口，用于院级系统与校级平台的用户一致认证和管理。详尽详情见Oauth说明文档。8对接用户认证开发指南一、Oauth2.0授权接见流程OAuth客户端OAuth服务器重定向用户到authorize接口生成authorize_code，重定向用户到redirect_uri使用authorize_code向access_token接口倡导央求生成access_token，并返回使用access_token向resource接口倡导央求返回用户信息获得用户信息（1）管理单位网站重定向用户到校级平台供应的authorize接口，若是用户赞成授权，校级平台会把用户重定向回到院

16、级单位网站,并附上授权码authorize_code；2）校级单位网站使用authorize_code向校级平台的access_token接口倡导央求，校级平台在考据央求合法后,会返回接见令牌access_token；3）校级单位网站使用access_token向resource接口倡导央求，获得用户信息。二、单位平台工作流程用户在校级平台倡导“预约仪器”央求，校级平台将央求重定向到院级平台。院级平台检查用户登录状态，若是登录状态，则直接转到仪器预约页面；若处于未登录状态，则转到步骤3代表的登录页面.单位平台的登录页面中要有“使用校级平台账号登录”入口。4.若用户选择直接使用院级平台账号登录，

17、则登陆后转到仪器预约页面;若用户选择“使用9校级平台账号登录，则开始oauth2.0授权认证过程。重定向用户到校级平台authorize接口，央求authorize_code。校级平台authorize接口接见标准以下：1)URLhttps:/mainplatform/oauth2/authorize2)HTTP央求方式GET/POST3)央求参数参数必选种类及范围说明client_idtruestring注册应用时分配的IDresponse_typetruestring返回种类，固定为coderedirect_uritruestring授权回调地址，需与注册时设置的回调地址一致scopetr

18、uestring申请scope权限所需参数，只供应read一种statetruestring用于保持恳求和回调的状态，在回调时,会回传该参数.开发者可以用这个参数考据央求有效性，也可以记录取户央求授权页前的地址。这个参数可用于防范跨站央求捏造（CSRF）攻击4)返回数据返回值字段字段种类字段说明codestring用于调用access_token接口，获得授权后的accesstokenstatestring若是传达参数，会回传该参数示例：央求：orm/response&response_type=codescope=readstate=STATE赞成授权后会重定向用户到：http:/subpl

19、atform/response？state=STATEcode=CODE院级平台获得authorize_code，接见校级平台的access_token接口,央求access_token。校级平台access_token接口接见标准以下：1)URLhttps:/mainplatform/oauth2/access_token2)HTTP央求方式POST央求参数10参数必选种类及范围说明client_idtruestring注册应用时分配的IDclient_secrettruestring注册应用时分配的secretgrant_typetruestring央求的种类，填写authorizatio

20、n_codecodetruestring调用authorize获得的code值redirect_uritruestring回调地址，需与注册应用里的回调地址一致4)返回数据返回值字段字段种类字段说明access_tokenstring用于调用资源接见接口，获取用户数据expires_instringaccess_token的生命周期，单位是秒数5)示例央求:https：/mainplatform/oauth2/access_token？client_id=CLIENT_ID&client_secret=CLIENT_SECRETgrant_type=authorization_code&code=CODE&redirect_uri=http:/subplatform/response成功获得后返回数据：”access_token：”ACCESS_TOKEN，expires_in：1234,获得校级平台返回的access_token，