《基础平台AP接入规范》由会员分享，可在线阅读，更多相关《基础平台AP接入规范（101页珍藏版）》请在金锄头文库上搜索。
1、基础平台AP接入规范1概述61.1概述：61.2基础平台的运行机制及接口说明61、基础数据来源说明62、公共服务平台基础平台定位73、接口定义74、接口使用说明85、名词解释说明82Passport接入规范92.1单点登录的原理92.2Passport单点登录介绍112.2.1总体介绍112.2.2术语解释132.3Passport接口说明132.3.1用户登录（login）132.3.2用户注册（register）152.3.3用户主动退出（logout）162.3.4检查登录用户（checkTicket）162.3.5用户会话失效处理（invalidate）172.3.6批量增加用户信息（
2、addAccounts）182.3.7批量查询用户信息（queryAccounts）192.3.8批量修改用户信息（modifyAccounts）192.3.9条件查询用户信息（searchAccounts）202.3.10查询存在的用户名212.3.11查询用户服务（queryService）212.3.12批量删除用户服务（removeServices）222.3.13批量删除用户（removeAccounts）222.3.14通知用户退出 232.4附录242.4.1Account定义242.4.2Server定义252.4.3ServerType定义262.4.4PassportExc
3、eption定义263数据同步及应用接入、监控类接口规范273.1需要AP提供的接口(HttpInvoke,Xml Post)283.1.1单位订购/退订(必须实现)283.1.2单位订购、退订(orderWare)(modifyUnitOrder)293.1.3用户订购、退订(modifyUserOrder)313.1.4单位信息同步(syncUnits)333.1.5同步学校信息(syncSchools)353.1.6各种基础数据删除(syncRemoved)363.1.7添加修改部门(syncDepartments)383.1.8添加修改教师(syncTeachers)403.1.9添加
4、修改年级(syncGrades)423.1.10添加修改班级(syncClasses)433.1.11添加修改学生(syncStudents)453.1.12添加修改家长信息(syncFamily)463.1.13用户信息(syncUsers)483.1.14单位批量订购、退订(batchModifyUnitOrder)503.1.15个人批量订购、退订(batchModifyUserOrder)533.2可选择接入接口(HttpInvoke,WebService)553.2.1调用的接口地址553.2.2key生成方式553.2.3登录日志(addUserLoginLog)56登录日志563
5、.2.4模块操作日志（addModuleOperationLog）56模块操作日志563.2.5用户操作行为(addUserOperation)56用户操作行为563.2.6添加用户积分行为(addUserScore)57添加用户积分行为573.2.7查询用户积分明细(queryDetailScoresByAccountId)57查询用户积分明细573.2.8查询用户总积分 (queryTotalScore)58查询用户总积分583.2.9异常数据处理结果反馈(returnSyncResult)58异常数据处理结果反馈583.2.10用户学习记录接口583.2.11用户教材设置接口593.2.
6、12单位、个人订购查询59单位个人订购记录查询593.2.13当前在线人数(需ap提供)603.2.14Ap功能页和介绍页(需ap提供)603.2.15AP接入需要提供的server信息613.3附录613.3.1EssServiceUnit定义：613.3.2BaseUnit定义：643.3.3BaseSchool定义：643.3.4EssServiceOrder定义653.3.5BaseDept 定义：653.3.6BaseTeacher定义：663.3.7BaseGrade定义：663.3.8BaseClass定义：673.3.9BaseStudent定义：683.3.10BaseFam
7、ily定义：693.3.11BaseUser定义：703.3.12UserLoginLog定义：713.3.13ModuleLog对象：713.3.14Account定义723.3.15LogUserOperation定义733.3.16UserScore定义733.3.17SyncServerInfo定义743.3.18FundsTransDto 定义743.3.19FundDetailDto 定义753.3.20WareSubscriberOrder定义753.4注意事项753.5代码相关763.5.1配置httpinvoke服务763.5.2加密字符串核对784硬件通讯接口规范784.1
8、缩略语784.2协议描述794.3数据类型和格式定义804.3.1数据类型定义804.3.2包格式概述804.3.3包格式布局804.3.4包内容常见数据说明814.3.5包的最大长度814.4考勤机参数配置接口包格式定义824.4.1报警信息处理操作824.4.2告警信息上报时间间隔更新834.4.3修改服务器IP地址端口号操作844.4.4心跳包864.4.5查询考勤机状态874.4.6时间校验884.5考勤机平安短信接口包格式定义894.5.1上传进出校信息操作894.5.2功能号总表905通讯终端技术规范905.11概述905.1.1范围905.1.2规范性引用文件915.1.3术语、
9、定义和缩略语915.2家校通专用终端设备业务需求915.2.1考勤报安类应用915.3家校通专用终端设备分类925.4考勤机终端功能要求935.4.14.1 基本功能935.4.2菜单功能935.4.3终端特性945.4.4终端可维护性975.5考勤机外接设备技术要求975.5.12.4G阅读器技术要求975.5.213.56M刷卡器技术要求986手机端接口1007短信接口1008统一支付规范1008.1付款通知接口（订购下单）1008.2商品退订接口（若没有则忽略）1018.3免费试用接口1018.4在线使用接口（若没有则忽略）1018.5商品下载接口（若没有则忽略）1019附录1029.1
10、RegisterUser定义1021 概述1.1 概述：浙江万朋所开发的公共服务平台基础平台按照招标文件要求是一个完全独立的业务应用管理，具体包括：l 单点认证管理l 数据传输管理l 应用接入管理l 应用信息推送管理l 应用监控管理l 短信通道接入管理l 支付中心管理l 智能手机端接入管理所有第三方应用（包括浙大万朋的应用）均需以空库（用户库）形式接入，防止应用厂家将陕西用户传输到自有的脱离陕西省教育厅监管的互联网平台。1.2 基础平台的运行机制及接口说明1、基础数据来源说明公共服务平台所有机构（教育局、学校）、教师、学生、家长数据均来源于待建的陕西教育基础数据库。传输机制为：机构向公共服务平
11、台基础平台申请开通公共服务平台服务-公共服务平台向基础数据库发起该机构数据传输-数据全量传输。2、公共服务平台基础平台定位公共服务平台基础平台作为所有教育教学及教育资源应用的基础平台向所有接入的第三方传输从基础数据库获得的基础数据。3、接口定义A统一认证接口-平台PASSPORT中心是相对独立的系统-按照顶层设计要求所有用户从基础数据库获取，原始账号规则：学生：s+学籍号 教师t+身份证号 家长：学生学籍号+家庭关系（父亲f+学籍号 母亲 m+学籍号。），用户第一次登录密码由平台用短信进行统一发送。用户首次登录后可完善相关信息，可以用手机号、qq号、邮箱进行登录。B应用管理接口-用于实现第三方
12、应用监控、管理、使用情况统计分析和用户前台应用广场自助订购及退订。C数据传输接口-用于向第三方应用传输除账号信息以外的教育逻辑数据、用户业务数据。数据传输接口模式两种：共享数据传输模式：第一种第三方按照数据接口接入，接入后如果用户订购（支持后台批量订购和前台自主订购）了第三方应用，那么第三方应用可以直接读取公共服务平台基础平台数据库种有关该用户的所有信息，用于业务应用不允许第三方存储用户数据，第三方只能做业务应用，所有有关用户信息显示全部调取基础平台的个人中心。推送数据传输模式：第二种接入方式第三方按照数据接口接入，接入后如果用户订购（支持后台批量订购和前台自助订购）了第三方应用，那么基础平台
13、将根据第三方要求的用户信息字段通过接口向第三方传输数据，第三方可保存用户数据。注意：按照顶层设计思想：为保证数据安全基础数据库不会全量给公共服务平台传输数据，要按照单位传输；同时公共服务平台也不会向第三方传输全量数据，要按照订购关系传输。（此部分也是做第三方应用监控的必备部分），同时为保证第三方不会抛离省厅独立运营，建议第二种数据传输方式一般不采用。D智能手机客户端应用接口-利用公共服务平台基础平台数据库和统一论证中心构建智能手机端基础平台，以保证所用用户三网体验一致、账号一致、数据一致，故在智能手机端构建了通讯录、教育公共服务号、教育微信等基础应用，同时增加应用广场，所有pc上的应用有智能手
14、机端的均可接入实现与pc端统一认证、统一数据E应用信息推送接口-用于通过基础平台实现各个应用之间信息相互推送。F短信接入管理接口-用于基础平台接入的三大运营商短信通道管理，同时用于向经教育厅及运营商认可的第三方应用提供短信发送能力。G统一支付中心管理-按照顶层设计要求，第三方收费应用必须通过应用广场的统一支付中心支付收费类业务的费用，统一支付到省厅指定账号，由省厅统一分配给第三方应用。4、接口使用说明第三方应用接入陕西教育教学公共服务平台首先需获得教育厅的认可。第三方应用接入时只选择接口A仅实现统一认证，实现跳转接入第三方应用接入时选择接口A、B、C 可实现统一认证、应用前台用户自助订购及后台批量订购并获取教育数据。第三方在选择A,B,C基础上自主选择以下接口可实现场景如下：D接口：选择A,B,C基础上实现与“陕西教育”智能手机端接入E接口：选择A,B,
