1. 开始使用

1.1. 一般约束

• 本文档仅适用于到梦空间开放平台的合作高校
• 接口协议：https
• 请求方式：post
• 批量查询数据接口重要说明：使用批量获取信息的接口时每次返回的数据限制500条，第一次查询不需要填写updateTime，第二次开始，需要把上一次调用接口返回数据中取到数据的最大updateTime值（使用接口返回的原值不要做任何修改，返回数据按照updateTime升序，只需要取最后一条数据的值即为最大值），依次循环调用接口获取全部数据，直至没有数据返回。

1.2. 接口调用方式

到梦空间提供 “中间库”请求接口地址

• 接口请求规则：https://ip:port/ [interface context]
• 线上环境请求接口地址：https://openapi.5idream.net

1.3. 请求参数

• 请求参数中分成两部分，一部分为我们称为公共请求参数（包括openId、token、sign_type、sign）；另一部分为具体参数，存放在info_content中，JSON格式，这部分我们称为业务请求参数（请参考每个业务接口说明）；
• 公共请求参数

• 业务请求参数请参考各业务接口

1.4. 生成签名值(sign)

第三方和到梦空间交互的每一次请求都必须签名

签名所需要的数据：

签名过程如下：

• 筛选 获取请求参数中的info_content值。
• 拼接 将info_content组合成参数=参数值的格式，并将md5_salt= signSalt连接到字符串最后端，此时生成的字符串为待签名字符串。 原值结构：info_content=$(info_content)& md5_salt= signSalt
• 调用签名函数 使用各自语言对应的MD5签名函数对待签名字符串进行签名(生成为32位16进制字符串)。

拼接后的待签名字符串：

info_content={"studentId":"34914298"}&md5_salt=B644510FDE4FA5DA4E0A8F5E3E308BEC

MD5加密后字符串：

0DBBE658BE9C997244BDA6D0766A2CB8

1.5. 数据安全

出于对数据的安全性考虑，到梦空间提供https协议，进行网络传输。以防止被人截取。 所有接口返回data需要aes解密。 获取token接口的key需要aes加密。

1.6. 成功响应数据格式

{
        "data": "VzhO49EXeFvuhP+KShc8doV6",
        "code" : "100",
        "success" : true,
        "msg": desc_comment
 }

将返回数据中的data字段使用AES解密得到返回值。（AES128加密模式：CBC，填充模式：PKCS5Padding，秘钥、iv偏移量、data是Base64编码的加密字符串）

1.7. 异常响应数据格式

{
    "code" : code_value,
    "success" : false,
    "msg": value
}

1.8. 批量操作数据校验异常响应数据格式

#如下是批量同步课程信息操作，数据校验异常会在异常数据内增加一个error提示
{
    "code": "-10010",
        "success": false,
        "msg": "批量操作数据校验不通过",
    "data": [{
        "error": "教务处课程ID没有传。",
        "className": "java编程之道",
        "outClassId": "",
        "teacherName": "赵老师",
        "term": 1,
        "year": "2020"
    }, {
        "error": "教务处课程ID没有传。学年没有传。",
        "className": "java编程之道2",
        "outClassId": "",
        "teacherName": "赵老师",
        "term": 2,
        "year": ""
    }]
}

1.9. 数据调用顺序

• 通过 "获取token" 拿到访问时需要的token；
• 业务请求时再把token放到请求头再传入业务接口。

1.10. 公共响应代码

• 以下为公共接口响应代码，接口特有的响应代码在各个接口中具体说明。

1.11. Demo下载

java

go

python