您的位置:首页 > 改革之路 > 政治法律 > 法制建设 法制建设
ULAS-API开放平台技术应用要则
作者:张岩、王林 来源:“图书馆之城”标准规范与技术应用要则 责任编辑:xiangwang 2024-10-25 人已围观
5.主要功能
ULAS-API开放平台的功能可分为四大类:认证类、查询类、操作类和数据类,本文件仅列出核心API功能。
5.1认证类API
“图书馆之城”统一认证平台基于业界标准(OAuth2.0和CAS)搭建,以拓展“图书馆之城”读者证的使用范围,规范第三方系统基于“图书馆之城”读者证的认证流程,确保“图书馆之城”读者数据安全。
统一认证平台提供多种登录方式,适用于不同场景。相应的认证类API接口主要针对读者身份的合法性、有效性进行验证。
5.1.1“读者证号/身份证号+密码”登录
功能:统一认证平台输入读者证号/身份证号及密码进行登录
路径:/auth/oauth/authorize
参数:传入读者证号/身份证号和登录密码
5.1.2公众号、App移动平台绑定登录
功能:实现读者移动端应用系统(如:公众号、App),绑定后免密登录
路径:/auth/oauth/authorize
参数:传入移动端应用系统ID和约定密钥
5.1.3手机扫码登录
功能:读者使用手机通过多种应用平台的扫码功能扫描PC端、自助设备登录二维码,授权登录。
路径:/MyLibrary/getLoginStr.jsp
5.1.4二维码亮码登录
功能:读者手机出示各类平台二维码(二维码读者证、粤读通、粤省事、电子社保卡等),系统解析二维码、识别读者身份。
路径:/readermanage/getQrCardDetail
参数:传入二维码字符串
5.2查询类API
5.2.1指定馆藏文献信息查询
功能:传入条码号参数,返回文献基本信息,包括书目信息和馆藏信息
路径:/circulationservice/getBookInfo
参数:传入条码号
5.2.2 OPAC馆藏文献信息查询
功能:根据关键词查询馆藏书目
路径:/opacservice/getQueryResult
参数:传入文献关键词(题名、作者、出版社等)
5.2.3 OPAC馆藏分布信息查询
功能:获取某一书目馆藏分布详情
路径:/opacservice/getBookDetail
参数:传入书目识别码ID
5.2.4读者当前借阅信息查询
功能:返回读者当前借阅文献列表
路径:/circulationservice/getLoanList
5.2.5读者当前借阅权限查询
功能:检查读者借阅状态、读者可借文献流通类型
路径:/circulationmanage/loanCheck
参数:传入读者ID、文献条码号
5.2.6指定文献流通历史查询
功能:根据ISBN号获取文献馆藏量、一年内流通数据信息
路径:/circulationmanage/getMetaInfo
参数:传入文献ISBN号
5.2.7读者个人基本信息查询
功能:获取读者详细个人信息(证号、姓名、手机号、性别等敏感信息脱敏)
路径:/readerservice/getReaderInfo
5.2.8读者个人年度账单
功能:获取读者年度首次借书详情、借书总量、借书金额、每月分布情况、预借量、数字资源使用量等。
路径:/sta/getReaderNewCard
5.2.9读者个人信用积分
功能:获取读者个人信用积分
路径:/sta/getReaderCredit
5.2.10读者个人阅读积分
功能:获取读者个人阅读积分
路径:/sta/readerMarkHistory
5.2.11获取读者证二维码图片
功能:获取实时刷新的读者证二维码图片
路径:/readerservice/getDesCardQRCode
5.2.12读者绑定第三方平台检查
功能:查询读者是否绑定微信、支付宝等平台
路径:/readerservice/checkBind
5.3操作类API
5.3.1按册续借文献
功能:按册续借文献
路径:/circulationservice/renew
参数:传入条码号
5.3.2按证续借文献
功能:按证续借文献(一键续借)
路径:/circulationservice/renewByReader
参数:传入读者证号参数
5.3.3文献上架
功能:更新馆藏动态架位,以便OPAC显示
路径:/circulationmanage/onshelf
参数:传入条码号
5.3.4新书选借
功能:借书操作(按照临时条码号生成规则)
路径:/circulationmanage/loanForCloud
参数:传入读者ID、文献条码号
5.3.5读者证二维码解码
功能:解析二维码读者证,识别读者身份
路径:/readermanage/getQrCardDetail
参数:传入二维码字符串
5.3.6读者注册
功能:核验照片和身份信息,办理读者证
路径:/readermanage/saveReaderByPhoto
参数:传入照片数据、读者身份信息
5.3.7读者证挂失
功能:读者遗失读者证后,通过网络挂失读者证、禁用读者证相关功能
路径:/readerservice/lostCardForReader
ULAS-API开放平台的功能可分为四大类:认证类、查询类、操作类和数据类,本文件仅列出核心API功能。
5.1认证类API
“图书馆之城”统一认证平台基于业界标准(OAuth2.0和CAS)搭建,以拓展“图书馆之城”读者证的使用范围,规范第三方系统基于“图书馆之城”读者证的认证流程,确保“图书馆之城”读者数据安全。
统一认证平台提供多种登录方式,适用于不同场景。相应的认证类API接口主要针对读者身份的合法性、有效性进行验证。
5.1.1“读者证号/身份证号+密码”登录
功能:统一认证平台输入读者证号/身份证号及密码进行登录
路径:/auth/oauth/authorize
参数:传入读者证号/身份证号和登录密码
5.1.2公众号、App移动平台绑定登录
功能:实现读者移动端应用系统(如:公众号、App),绑定后免密登录
路径:/auth/oauth/authorize
参数:传入移动端应用系统ID和约定密钥
5.1.3手机扫码登录
功能:读者使用手机通过多种应用平台的扫码功能扫描PC端、自助设备登录二维码,授权登录。
路径:/MyLibrary/getLoginStr.jsp
5.1.4二维码亮码登录
功能:读者手机出示各类平台二维码(二维码读者证、粤读通、粤省事、电子社保卡等),系统解析二维码、识别读者身份。
路径:/readermanage/getQrCardDetail
参数:传入二维码字符串
5.2查询类API
5.2.1指定馆藏文献信息查询
功能:传入条码号参数,返回文献基本信息,包括书目信息和馆藏信息
路径:/circulationservice/getBookInfo
参数:传入条码号
5.2.2 OPAC馆藏文献信息查询
功能:根据关键词查询馆藏书目
路径:/opacservice/getQueryResult
参数:传入文献关键词(题名、作者、出版社等)
5.2.3 OPAC馆藏分布信息查询
功能:获取某一书目馆藏分布详情
路径:/opacservice/getBookDetail
参数:传入书目识别码ID
5.2.4读者当前借阅信息查询
功能:返回读者当前借阅文献列表
路径:/circulationservice/getLoanList
5.2.5读者当前借阅权限查询
功能:检查读者借阅状态、读者可借文献流通类型
路径:/circulationmanage/loanCheck
参数:传入读者ID、文献条码号
5.2.6指定文献流通历史查询
功能:根据ISBN号获取文献馆藏量、一年内流通数据信息
路径:/circulationmanage/getMetaInfo
参数:传入文献ISBN号
5.2.7读者个人基本信息查询
功能:获取读者详细个人信息(证号、姓名、手机号、性别等敏感信息脱敏)
路径:/readerservice/getReaderInfo
5.2.8读者个人年度账单
功能:获取读者年度首次借书详情、借书总量、借书金额、每月分布情况、预借量、数字资源使用量等。
路径:/sta/getReaderNewCard
5.2.9读者个人信用积分
功能:获取读者个人信用积分
路径:/sta/getReaderCredit
5.2.10读者个人阅读积分
功能:获取读者个人阅读积分
路径:/sta/readerMarkHistory
5.2.11获取读者证二维码图片
功能:获取实时刷新的读者证二维码图片
路径:/readerservice/getDesCardQRCode
5.2.12读者绑定第三方平台检查
功能:查询读者是否绑定微信、支付宝等平台
路径:/readerservice/checkBind
5.3操作类API
5.3.1按册续借文献
功能:按册续借文献
路径:/circulationservice/renew
参数:传入条码号
5.3.2按证续借文献
功能:按证续借文献(一键续借)
路径:/circulationservice/renewByReader
参数:传入读者证号参数
5.3.3文献上架
功能:更新馆藏动态架位,以便OPAC显示
路径:/circulationmanage/onshelf
参数:传入条码号
5.3.4新书选借
功能:借书操作(按照临时条码号生成规则)
路径:/circulationmanage/loanForCloud
参数:传入读者ID、文献条码号
5.3.5读者证二维码解码
功能:解析二维码读者证,识别读者身份
路径:/readermanage/getQrCardDetail
参数:传入二维码字符串
5.3.6读者注册
功能:核验照片和身份信息,办理读者证
路径:/readermanage/saveReaderByPhoto
参数:传入照片数据、读者身份信息
5.3.7读者证挂失
功能:读者遗失读者证后,通过网络挂失读者证、禁用读者证相关功能
路径:/readerservice/lostCardForReader
很赞哦! ( )
评论
0