业务接口请求
请求业务接口时,需要在header中包含授权参数
- 1、调用业务接口时不需要传appid(header的key为:X-AUTH-OPENPLATFORM-APP-ID),只有调用getToken、refreshToken 时,才需要传appid(X-AUTH-OPENPLATFORM-APP-ID)。
- 2、调用通用营销接口时,文档中有特殊要求「请求header中需要传"appId"」的,需要加一个通用营销要用的appId,header的key就是appId(不要写成:X-AUTH-OPENPLATFORM-APP-ID)。
header参数:
参数名 | 描述 | 数据类型 | 必填 | 字节长度 | 示例 |
---|---|---|---|---|---|
X-AUTH-OPENPLATFORM-TOKEN | access token | String | 是 | 256 | hozrJfiKHCamC3pTXHLEx1lzZ4bkK5nFmejY |
X-AUTH-SIGN | 签名 | String | 是 | 500 | 详见示例: 签名方式, 注意签名方式和获取token签名方式不同 |
X-TIME-STAMP | 时间戳 | String | 是 | 20 | 1631946536000 |
X-Client | 调用方类型 | String | 是 | 10 | android / ios / web / server / open |
User-Agent | UA,用于记录客户端信息 | String | 是 | 100 | 服务端默认值:curl |
companyUuid | 公司uuid | String | 100 | 是 | 32221635-C638-4A8E-8F26-8E7C6B58EAEB |
请求示例:
curl -X POST 'https://qfopenapi.qiaofangyun.com/api/jediopenplatformopenapi/organization/department/searchDepartment'
--header 'X-AUTH-OPENPLATFORM-TOKEN: b1f8509ca53b4b9691860b3298a7e99f' \
--header 'X-AUTH-SIGN: 9d1d672fc12097c7e5f5603e3c7d954db2e181c3' \
--header 'X-TIME-STAMP: 1632280869000' \
--header 'X-Client: server' \
--header 'User-Agent: curl' \
--header 'companyUuid: 32221635-C638-4A8E-8F26-8E7C6B58EAEB' \
{ \
"param": { \
"businessType": "BUSINESS_DEPT" \
} \
}'
签名方式
import org.apache.commons.codec.digest.DigestUtils;
String sign = DigestUtils.sha1Hex(accessToken + "|" + timeStamp + "|" + appSecret);