获取平台用户token接口文档

1概述

1.1请求规则

规则名称	描述
请求地址(测试环境)
请求方式	GET/POST
参数格式	application/json
字符编码	统一采用UTF-8字符编码

1.2安全控制

系统采用如下方式保证产品需求方平台的安全性

平台各接口支持HTTPS协议。
访问任意接口都需要验证签名才能访问。

2接口说明

2.1获取C端用户token

接口地址

/api/opendata/user/getToken`

功能说明
1、分配给伙伴系统APPKEY,通过此接口获取平台的C端用户token
2、token有效期24小时，用此token作为参数，可以单点登录到平台小程序端相关业务服务。
请求方式

请求方法: POST

Content-Type: application/json

编码方式: UTF-8

请求方式

请求方法: POST

Content-Type: application/json

编码方式: UTF-8

请求参数

参数名称	参数类型	是否必须	示例值	描述
orgCode	string	是	1000234	项目编码
userMobile	string	是	20230708	用户号码
userName	string	是	张三	用户姓名
nickName	string	否	张三	昵称
openid	string	是		openid
virtCode	string	否	1234	企业编码需要加入到企业员工，该字段必传
timestamp	Long	是	1574651175506	时间戳，以毫秒为单位
sign	string	是		签名，详见签名规则
appKey	string	是		fwzc8EtxzIfX9Ql3Hmgh

返回值

参数名称	参数类型	是否必须	示例值	描述
code	int	是	200	响应状态码
msg	string	是	签名错误	返回状态码信息
data	object	是		返回结果

code说明

code状态码	说明
200	成功
500	失败

data返回值说明

参数名称	参数类型	是否必须	示例值	描述
token	string	是		用户token
effectiveTime	Long	是		有效期，单位秒

3签名规则

3.1签名介绍

调用接口都需要携带签名,服务端会根据请求参数,对签名进行校验,签名不合法的请求将会被拒绝。

3.2签名方法

以接口/api/opendata/userquery为例

请求的参数如下

appKey：fwzc8EtxzIfX9Ql3Hmgh
timestamp：1680580829000
userId：ZZGX20230404173443981

平台方提供的密钥secretKey为77f44bf82004154f763a2eb4fa096487a017fe9c

将请求参数中除appKey、sign外的多个键值对,根据键按照字典序排序,并按照key1=value1&key2=value2...的格式拼成一个字符串。

string str = "userId=ZZGX20230404173443981&timestamp=1680580829000";

将secretKey拼接在第一步中排序后的字符串后面得到待签名字符串。

string signTemp = str + "&secretKey=77f44bf82004154f763a2eb4fa096487a017fe9c";
//userId=ZZGX20230404173443981&timestamp=1680580829000&secretKey=77f44bf82004154f763a2eb4fa096487a017fe9c

对待签名字符串求MD5摘要并转为大写即为sign：4CC2EB02383141C666F14D0EE681FB7A

需要注意以下规则

请求参数的值为空则不参与签名
参数名区分大小写
appKey、sign参数不参与签名
附录：结果码code说明

code状态码	说明
200	成功
500	失败

文档更新时间: 2025-03-28 11:50 作者：吴长福

获取平台用户token