QrCode
February 26, 2024About 2 min
QrCode
SDK类名：/common/Qr;
二维码-1.时间戳
SDK方法名：describeTimeStamp;
URL
/qr/t
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| timestamp | Number | 否 | , Unix 时间戳 | 1546847673 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | @mock= | ||
| ret | Number | 否 | @mock=200 | 200 | |
| data | Object | 否 | |||
| t | String | 否 | @mock="152895584599651732", 毫妙+随机串 | "152895584599651732" | |
| code | Number | 否 | @mock=0 | 0 | |
| message | String | 否 | @mock= |
二维码-2.获取二维码内容
生成登录用的二维码内容
SDK方法名：obtainQrContent
URL
/qr/generate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| app_name | String | 否 | APP类型名称, 可选 | enterpriseApp |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| content | Object | 否 | |||
| t | String | 否 | msec + Math.floor(Math.random() * 99999), 时间戳毫秒+5位随机数 | ||
| uuid | String | 否 | , 二维码唯一标识,确认登录后，该标识作为token，直接登录 | ||
| message | String | 否 | @mock= | ||
| code | Number | 否 | @mock=0 | 0 | |
| msg | String | 否 | @mock= | ||
| ret | Number | 否 | @mock=200 | 200 |
二维码-3.生成二维码图片
SDK方法名：createQrPic
URL
/qr
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| point_size | Number | 否 | 非必填, 色块像素(大小) | 1 | |
| text | String | 否 | 二维码内容, 必填 | test | |
| format | String | 否 | 非必填，示例：base64，png，（支持base64，和直接输出image）, 输入格式 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| png | String | 否 | base64图片 | data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMsAAADLAQMAAAD6NfVwAAAABlBMVEX///8AAABVwtN+AAABMUlEQVRYhe2Xuw2EMAyGHV1ByQiMktHCaIxyI1BSIHy/7YSH0NXYEi4Izpfmlx9xiF57yj4stsky0UbUq78EQfrFHg08wuu/+2YEBCXjRt08TGUTlKEyGEI0pgI/KsLyT5dbZBl1BOWWbI5RrWURpLruZe4XVfvwTJl5pbs5RtgbrJYpj0CXoHhH1DGiUdtnYjm4ywuApA54VV2JF+1HTZd3pEHhZAWQIEgOchSEL1IJhqDIAHFKNv9InJJWTSwVhNhYRsVAWWTNcHTJpwbrHWnvb7pWHd2OezkCYnRR0Zb08hprI/KPqklJT604UhRUJwf5zW1mu449nlGb2fDIKslqORBqY7KkklkLVBikHegsLxCqjyyb4DgO0oyyWtbnSiRktazXWJ07j5nNO3rtGfsBkXUNzx0duJIAAAAASUVORK5CYII= |
二维码-4.确认/取消登录
SDK方法名：
确认登录：confirmLogin
取消登录：cancelLogin
检查有效性：checkQrValidity
URL
/qr/event
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| action | Number | 否 | 0，扫描时访问，用于检查二维码有效性；1，确认登录；2，取消登录, 确认或取消登录 | 1 | |
| uuid | String | 否 | , 二维码唯一ID | 9169240e9e5fa86a115578b9ed151c34771ca22e |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | @mock= | ||
| ret | Number | 否 | @mock=200 | 200 | |
| data | Object | 否 | |||
| message | String | 否 | @mock= | ||
| code | Number | 否 | @mock=0 | 0 |
二维码-5.检查二维码状态
SDK方法名：checkQrStatus
URL
/qr/status
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| uuid | String | 否 | , 二维码唯一id | 0d6e290f9c8414bac0bb105b97232771ec3e5178 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | @mock= | ||
| data | Object | 否 | |||
| code | Number | 否 | @mock=0 | 0 | |
| status | Number | 否 | 0,正常，未绑定，未过期；1，登录已确认，可直接跳转； 2，登录取消，需要重新获取 ；3，已通过APP扫描，未确认登录，未取消登录；9，二维码过期需要刷新重新获取；, 状态码 | ||
| message | String | 否 | @mock= | ||
| ret | Number | 否 | @mock=200 | 200 |