术语
服务商:服务商教育号合作伙伴,可以为客户提供定制化的教育应用和解决方案。
应用:应用是在教育号平台上开发的应用程序,能够与教育号进行集成,提供消息推送、审批流程、考勤管理等功能,以满足教育局和学校内部的协作和管理需求。
token:token是教育号派发的动态票据,用于访问教育号平台的接口。它是根据应用secret和其他参数生成的访问凭证,用于标识和验证第三方应用的身份和权限,具有一定的有效期。
第三方应用在调用教育号平台的接口时,需要携带有效的token进行身份验证。
为了更好地管理和控制系统中的身份验证和权限访问,教育号设计了3种类型的token,下表是各个token的区别:
凭证类型 | 获取条件 | 说明 | 适用场景 | 获取方式 |
---|---|---|---|---|
应用凭证 | 应用上架 | 应用token,表示应用身份 | 获取平台上和机构无关的通用数据,极少使用 | 应用凭证管理 |
机构凭证 | 应用上架且安装到机构 | 机构token,表示应用在机构中的身份 | 应用和平台后台对接获取机构相关的数据,普遍使用 | 应用安装授权 |
用户凭证 | 应用上架且安装到机构后,用户授权登录 | 用户token,表示用户身份 | 获取必须要用户登录才能访问的数据,极少使用 | 用户凭证管理 |
应用secret: 应用secret是在教育号平台注册应用时生成的密钥,用于验证应用的身份和权限。它是与应用ID相对应的机密信息,需要妥善保管,用于与教育号平台进行安全通信。
ticket: ticket是教育号每10分钟一次派发的动态身份表示,用于从平台获取应用token。
permanent_code: 应用安装时,给机构分发的密钥,用户获取机构身份的token。
code: code是用户在教育号平台进行授权登录后,返回给第三方应用的临时授权码。第三方应用可以使用该授权码获取用户的访问令牌(用户态的access_token),以便进行用户信息的获取和操作。
应用上线:应用接入开发、测试完成,达到可用状态后,服务商申请提交应用上线申请,等平台运营管理员审核通过上线;
应用上架:应用上线后,可以把应用加入指定的应用市场,机构管理员可在机构的应用市场看到应用;
应用安装:管理员将应用安装到机构,机构成员可以点击打开应用,安装时应用侧会收到安装回调,通过回调下发的临时授权码可以获取到永久授权码,通过永久授权码可以获取机构token,访问教育号接口;
接口字段
字段名 | 类型 | 说明 |
---|---|---|
appid | uint64 | 应用唯一标识,开发者在教育号注册应用时由教育号分配的应用id,(服务商后台应用详情的SuiteId) |
secret | string | 应用注册是,自动分配 |
corpid | uint64 | 机构id,表示一个学校或教育行政机构 |
department_id | uint64 | 组织架构id,表示一个机构内的部门,在机构内唯一; |
userid | string | 用户id,表示一个机构内用户,在机构内唯一;corpid+userid可以全局范围内唯一标识一个用户; |
child_id | string | 孩子的userid,同userid |
role_id | uint32 | 角色id, 参考角色类型 |
suite_ticket | string | suite_ticket 与 secret 配套使用,用于获取 suite_access_token |