AP接入规范.doc

基础平台AP接入规范 1 概述 6 1.1 概述： 6 1.2 基础平台的运行机制及接口说明 6 1、基础数据来源说明 6 2、公共服务平台基础平台定位 7 3、接口定义 7 4、接口使用说明 8 5、名词解释说明 8 2 Passport接入规范 9 2.1 单点登录的原理 9 2.2 Passport单点登录介绍 11 2.2.1 总体介绍 11 2.2.2 术语解释 13 2.3 Passport接口说明 13 2.3.1 用户登录（login） 13 2.3.2 用户注册（register） 15 2.3.3 用户主动退出（logout） 16 2.3.4 检查登录用户（checkTicket） 16 2.3.5 用户会话失效处理（invalidate） 17 2.3.6 批量增加用户信息（addAccounts） 18 2.3.7 批量查询用户信息（queryAccounts） 19 2.3.8 批量修改用户信息（modifyAccounts） 19 2.3.9 条件查询用户信息（searchAccounts） 20 2.3.10 查询存在的用户名 21 2.3.11 查询用户服务（queryService） 21 2.3.12 批量删除用户服务（removeServices） 22 2.3.13 批量删除用户（removeAccounts） 22 2.3.14 通知用户退出 23 2.4 附录 24 2.4.1 Account定义 24 2.4.2 Server定义 25 2.4.3 ServerType定义 26 2.4.4 PassportException定义 26 3 数据同步及应用接入、监控类接口规范 27 3.1 需要AP提供的接口(HttpInvoke,Xml Post) 28 3.1.1 单位订购/退订(必须实现) 28 3.1.2 单位订购、退订(orderWare)(modifyUnitOrder) 29 3.1.3 用户订购、退订(modifyUserOrder) 31 3.1.4 单位信息同步(syncUnits) 33 3.1.5 同步学校信息(syncSchools) 35 3.1.6 各种基础数据删除(syncRemoved) 36 3.1.7 添加修改部门(syncDepartments) 38 3.1.8 添加修改教师(syncTeachers) 40 3.1.9 添加修改年级(syncGrades) 42 3.1.10 添加修改班级(syncClasses) 43 3.1.11 添加修改学生(syncStudents) 45 3.1.12 添加修改家长信息(syncFamily) 46 3.1.13 用户信息(syncUsers) 48 3.1.14 单位批量订购、退订(batchModifyUnitOrder) 50 3.1.15 个人批量订购、退订(batchModifyUserOrder) 53 3.2 可选择接入接口(HttpInvoke,WebService) 55 3.2.1 调用的接口地址 55 3.2.2 key生成方式 55 3.2.3 登录日志(addUserLoginLog) 56 登录日志 56 3.2.4 模块操作日志（addModuleOperationLog） 56 模块操作日志 56 3.2.5 用户操作行为(addUserOperation) 56 用户操作行为 56 3.2.6 添加用户积分行为(addUserScore) 57 添加用户积分行为 57 3.2.7 查询用户积分明细(queryDetailScoresByAccountId) 57 查询用户积分明细 57 3.2.8 查询用户总积分 (queryTotalScore) 58 查询用户总积分 58 3.2.9 异常数据处理结果反馈(returnSyncResult) 58 异常数据处理结果反馈 58 3.2.10 用户学习记录接口 58 3.2.11 用户教材设置接口 59 3.2.12 单位、个人订购查询 59 单位个人订购记录查询 59 3.2.13 当前在线人数(需ap提供) 60 3.2.14 Ap功能页和介绍页(需ap提供) 60 3.2.15 AP接入需要提供的server信息 61 3.3 附录 61 3.3.1 EssServiceUnit定义： 61 3.3.2 BaseUnit定义： 64 3.3.3 BaseSchool定义： 64 3.3.4 EssServiceOrder定义 65 3.3.5 BaseDept 定义： 65 3.3.6 BaseTeacher定义： 66 3.3.7 BaseGrade定义： 66 3.3.8 BaseClass定义： 6