文档说明

## 一、api介绍 仅供企业客户使用,通过该api,企业可自由设计相关业务展示。 ## 二、注册使用 ### 1、注册企业账号 在平台注册公司账户,获得以下两个参数: enterpriseKey secret ### 2、公共参数 接口header必传以下四个参数: header.set("ENTERPRISE-KEY",enterpriseKey); header.set("TIMESTAMP",timestamp+"");//当前时间戳,单位毫秒 header.set("SIGN",sign); header.set("SOURCE",6); header.set("cluster",cluster); 其中:sign= md5(enterpriseKey + secret + timestamp + 接口路径);//sign全部为小写,譬如123456加密后是e10adc3949ba59abbe56e057f20f883e 接口路径不包括域名和接口上的拼接参数,例:/openapi/client/batch/add; cluster的值根据enterpriseKey如果是E5000到E7000开头则为bjb,其他情况为bja,譬如enterpriseKey为E5123_224则cluster为bjb,enterpriseKey为E112_333则cluster为bja ### 3、请求数据: 按各接口定义即可,对于分页请求的参数注意如下: ``` pageindex=1 ``` pageindex表示页码,默认pagesize=50,暂不允许用户传参 如果后台开启了客户手机号加密,则获取到的手机号为DES加密手机号,需要通过后台开发配置模块下的Secret进行DES解密获取手机号明文,如果获取到的客户信息中名字和手机号相同,则客户名字也会进行加密处理,请根据需要进行解密,同时,调用接口进行客户新增,也需要传递DES加密的手机号参数 ### 4、限制访问 每个api访问频次限制最大1次/100毫秒,超过则返回失败。 请求参数timestamp与标准北京时间不得超过1分钟,超过则返回失败。 企业停用或恢复后,需等待10分钟后生效 ### 5、返回数据:统一返回json字符串格式 ```language { code:0, message:"test", data:[]或{}, listCount:0 } ``` 说明: code:-1异常返回,0正常返回,1表示正在查询,只返回部分数据,需要再次请求,2表示全部查询完成,数据为全。 message:只有code为-1时才会有错误提示 data:为业务数据,可能为List也可能为单个对象(名称以列表结尾的接口返回数据类型为List) 注:本文档后续接口的返回数据描述中只描述data中的数据,请知晓。 listCount:总数,数据量较大的接口,将采用分页请求,此时返回数据带有该参数。 ### 6、统一错误返回 权限限制、参数错误等会统一返回此json ```language { errorCode:9, errorDescription:"" } ``` |errorCode|含义| |-|-|-| |5|服务器时间不一致| |6|请求太频繁(每100毫秒不超1次)| |7|sign校验失败| |9|参数错误| |503|企业不存在或已停用|