对接方式 - 网易七鱼 API

说明：所有接口均需符合七鱼对企业接口的请求格式规范和返回格式规范，其规范见下文。目前七鱼调用第三方接口时会加上的鉴权方式有两种，一是token校验（复用CRM信息对接里获取token的接口，若能获取到token则使用该token，获取不到token则不使用，此种需企业提供appId,appSecret和获取token的接口），另一种是checkSum校验，需企业提供appId和appSecret,生成checkSum方式见下文。企业可依据不同模块情况采用任意校验方式，或不使用身份校验。

企业接口请求说明

获取token接口的请求方式同CRM对接文档里相同；

一触即达的所有接口请求均为POST请求；

一触即达的所有接口请求的Content-Type类型均为：application/x-www-form-urlencoded;charset=utf-8。例：

POST https://qiyeserver/...  HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

企业接口返回说明

返回字段定义：

参数	是否必填	参数说明
code	是	请求的返回码
desc	否	描述信息
result	是	接口调用结果

所有一触即达企业接口的返回类型为JSON，同时进行UTF-8编码；

接口的返回值在result字段里，可以是任何对象，只有code=200时才认为调用成功，并使用result字段里的内容做后续操作。例：

{
  "code": 200,
  "desc": "success",
  "result": {
    "id": "123456",
    "name": "hello world",
    "address": "浙江省杭州市滨江区长河街道网商路599号网易大厦"
  }
}

接口调用流程

若接口不需请求校验并对所有人开放，则接口只需符合上文所列的请求和返回规范即可。

分配appId和appSecret，企业需在页面：接入设置->信息对接->CRM信息对接处填写给七鱼分配的appId和appSecret用于获取token和生成checkSum校验；

若企业设置了获取token接口，并且七鱼成功获取到token后，会在七鱼调用企业一触即达接口时将token作为参数带上；

七鱼在调用企业接口时，将appSecret，time，nonce三个参数使用sha1哈希算法生成checkSum校验和（同消息接口checksum校验和示例代码），其中time为精确到秒的时间戳，nonce为一串随机生成的字符串,参数放在Http Request Header中传输；

POST请求调用第三方接口，七鱼会带上的请求参数有：userId（String字符串类型），plgCode（String字符串类型），params（Map键值对类型，包含请求所需参数，需要企业在一触即达查询节点里进行设置），请求参数放在请求体里。

参数说明

参数	是否必填	参数说明
appId	是	企业分配给七鱼的appId
nonce	是	随机字符串（最大长度128个字符）
time	是	当前UTC时间戳，精确到秒数
checkSum	是	SHA1(appSecret + nonce + time),将三个参数按appSecret、nonce、 time顺序拼接成的字符串计算SHA1哈希值，并转化成16进制的小写字符串作为checkSum
userId	是	开发者的应用里的用户ID，通过CRM接入同步给七鱼
plgCode	是	七鱼要调用的对应模块名称
params	是	调用第三方接口的参数列表，企业在一触即达的查询节点里进行配置
token	否	获取到的企业token