上云上平台接口规范.pdf

上云上平台接口规范 版本修订批准记录 【 历次版本修订记录，版本修订描述重要说明】 提交日期 版本号 版本修订描述 修改人 备注 2019-2-25 0.9 初稿 潘锡均 2019-03-07 1.0 完善 杨钊 目录 1 接口功能说明 1.1 概述 1.1.1 设计目的 本规范明确上云上平台与相关的供应商的接口协议， 为开发人员在进行接口设计、 开发、 使 用过程中提供指导性意见。 1.1.2 加密协议 使用 rsa 和 aes 相结合的方法加密接口返回数据， 上云上平台 通过请求头方式将公钥告知 各个供应商接口，各个供应商接口返回数据时，需要通过 aes 算法对返回数据进行加密，同 时也需要利用公钥，对 aes 密钥进行加密处理返回。 相关代码见附录 1.1.3 编码格式 统一是用 UTF-8 1.2 接口功能说明 1.2.1 使用说明 用户 id 、操作开始时间、操作结束时间，获取对应用户操作数据信息 1.2.2 请求 .1 请求参数 统一请求头 参数名称 说明 数据类型 可空 Content-Type 固 定 数 据 类 型 application/json; String N charset=UTF-8 RSAPublicKey Rsa 公钥 String N data 参数名称 说明 数据类型 可空 userId 系统用户 id ，可以多个，以逗号分割 String N beginTime 操作时间——开始 yyyyMMddHHmmss long N endTime 操作时间——结束 yyyyMMddHHmmss long Y .2 请求的 json 文档格式示例 { beginTime:20190306000000, endTime:20190307000000, userId15994705655 } .3 请求的安全问题 建议对固定 ip 做白名单处理 (54, 53, 0) 返 回 .1 返回参数 参数名称 说明 数据类型 可空 respCode “0”：成功，其它：失败。 String N respMsg 返回值详细说明 String N data CryptoData 实体 Object N key Strin 加密的 Aes 密钥， N g