“单点登录接口开发文档”的版本间的差异
来自成绩云帮助中心
(→签名参数sign生成说明) |
(→单点登录) |
||
第24行: | 第24行: | ||
|平台ID | |平台ID | ||
|- | |- | ||
− | | | + | |orgId |
− | | | + | |string |
|是 | |是 | ||
− | | | + | |学校ID |
|- | |- | ||
− | | | + | |role |
|string | |string | ||
|是 | |是 | ||
− | | | + | |角色名称:管理员、教师或学生 |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
− | | | + | |name |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|string | |string | ||
− | | | + | |是 |
+ | |用户姓名。对于管理员,双方要约定创建这样的账号。对于有重名的教师,需要双方约定传一个别名,例如“张老师”、“张老师2”。学生通过年级和班别值来区分重名的情况。 | ||
|- | |- | ||
|grade | |grade | ||
|string | |string | ||
+ | |对于学生是,其它角色否 | ||
|年级 | |年级 | ||
|- | |- | ||
− | | | + | |class |
|string | |string | ||
+ | |对于学生是,其它角色否 | ||
|班别 | |班别 | ||
|- | |- | ||
− | | | + | |timestamp |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|int | |int | ||
− | | | + | |是 |
+ | |时间戳(Unixtime),有效时长600秒 | ||
|- | |- | ||
− | | | + | |sign |
|string | |string | ||
− | | | + | |是 |
+ | |签名,只对platform和timestamp签名,不用对POST数据内容签名。详见[https://chengjiyun.com/wiki/index.php?title=%E7%BA%AA%E5%BE%8B%E6%98%9F%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%96%87%E6%A1%A3#.E7.AD.BE.E5.90.8D.E5.8F.82.E6.95.B0sign.E7.94.9F.E6.88.90.E8.AF.B4.E6.98.8E 签名参数sign生成说明] | ||
|} | |} | ||
− | |||
== <p style="background:#6a9ee4;padding:8px 12px;color:#ffffff;">签名参数sign生成说明</p> == | == <p style="background:#6a9ee4;padding:8px 12px;color:#ffffff;">签名参数sign生成说明</p> == |
2022年2月22日 (二) 16:17的版本
前言
本文档针对只做单点登录、不做数据同步的平台而编写。
接入知未产品单点登录的平台需要先联系知未科技研发,获取2个基本参数:平台ID[platform],平台密钥[key]。这两个参数也可以反过来向知未科技提供。
单点登录
第三方平台按如下方式构造知未产品(例如“成绩分析”)的入口链接:
- 接口说明
请求方式:GET
请求URL: [serverBaseUrl]/good-class/api/import?platform=[platform]×tamp=[timestamp]&sign=[sign]
URL参数说明:
参数 | 类型 | 是否必填 | 描述 |
platform | string | 是 | 平台ID |
orgId | string | 是 | 学校ID |
role | string | 是 | 角色名称:管理员、教师或学生 |
name | string | 是 | 用户姓名。对于管理员,双方要约定创建这样的账号。对于有重名的教师,需要双方约定传一个别名,例如“张老师”、“张老师2”。学生通过年级和班别值来区分重名的情况。 |
grade | string | 对于学生是,其它角色否 | 年级 |
class | string | 对于学生是,其它角色否 | 班别 |
timestamp | int | 是 | 时间戳(Unixtime),有效时长600秒 |
sign | string | 是 | 签名,只对platform和timestamp签名,不用对POST数据内容签名。详见签名参数sign生成说明 |
签名参数sign生成说明
第一步:
对传入的参数按照键名排序
第二步:
使用URL键值对的格式(即key1=value1&key2=value2…)拼接成字符串stringA
第三步:
在stringA最后拼接上“&key=[平台密钥]”得到stringSignTemp字符串,并对stringSignTemp进行MD5运算
第四步:
得到最终请求字符串sign
PHP签名算法示例:
// $key 平台密钥 function sign($data, $key) { ksort($data); // 正向排序 $key_str = urldecode(http_build_query($data)); // 连接字符串 $key_str .= '&key=' . $key; // 拼接key return md5($key_str); } $data = array( 'orgId' => 'testSchool', 'role' => '教师', 'name' => '李老师', 'timestamp' => 1639017000, ); $sign = sign($data, $key);
注意:一般接口会有一个timestamp参数,如无特别说明,timestamp的有效时间为7200秒,超过该时长请求无效,以降低受到重放攻击的风险。