接口通用说明

调用方式

开放平台接口开发者需通过HTTP/HTTPS POST方式调用，并按照接口声明，填充相应请求参数信息。发起请求调用后，七鱼系统会返回相应回复数据，如果请求不合法或发生异常，系统会返回相应的错误码，开发者可根据返回状态码自行排查问题。

鉴权认证方式

开放平台接口会做统一的鉴权认证，开发者在调用接口时，需要将以下鉴权信息字段填充到url参数中。

字段	类型	注释
appKey	string	七鱼分配给企业的appKey
time	long	当前 UTC 时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数
checksum	string	用于校验数据的完整性，SHA1(appSecret + md5 + time)，由三个参数拼接的字符串，进行SHA1哈希计算，转化成16进制字符(String，小写)

备注： appKey 和 appSecert 可在七鱼企业管理后台“系统-扩展与集成-开发者ID”页查看。 checksum 中的 md5 为 POST请求的 body 内容字符串的 md5 哈希值（小写形式），即 md5 = MD5(bodyContent).toLowerCase()，如果是上传文件，则是整个文件内容的md5。出于安全性考虑，每个 checksum 的有效期为 5 分钟，请确认发起请求的服务器是与标准时间同步的，比如有NTP服务。

计算 checksum 的 Java 示例代码如下：

返回状态码

code	说明
200	无错误
14001	appKey不存在
14002	checksum计算错误
14003	time已过期
14004	内容错误，字段格式或字段值不合法
14008	ip黑名单
14009	触发接口频率限制
14500	系统错误，通常是服务器内部错误
14501	内容长度限制
14515	无接口访问权限

调用方式#

鉴权认证方式#

返回状态码#

调用方式

鉴权认证方式

返回状态码