微信扫码登录

使用微信APP实现扫码登录
¥0.001/次
API文档

公共参数

公共请求说明

说明描述
请求地址登录后可见
请求方式GETPOST

公共请求参数

参数类型是否必填描述
methodstring接口名称,当前接口名称:scanlogin
app_idstring草庐分配给你的应用ID
signtypestring加密方式,目前固定为:md5
signstring签名串,详见签名
versionstring接口版本号,当前接口版本:v1.0
biz_contentstring业务参数合计,json字符串

业务请求参数

参数类型是否必填描述
typestring

业务类型。

获取扫码图片:getscancode,包括账号绑定和登录都使用该业务类型

获取扫码结果:checktoken,用户完成后会返回用户唯一标识,建议每3秒轮训一次

scantypestring

type为getscancode时必填

扫码的类型,值为:0、1。0为绑定,1为登录;

需要注意,需要先让用户绑定,用唯一标识跟自己系统的用户体系绑定,再做登录,这样登录才能知晓是哪个用户

sitetypestring

type为getscancode时必填

平台属性,如网站、APP等

sitenamestring

type为getscancode时必填

平台名称

tokenstring

type为checktoken时必填

token值在获取扫码图片时会返回

公共响应参数

参数类型是否必填描述
codestring网关返回码,success或fail
msgstring网关返回码描述
runtimestring系统执行时间,单位秒
dataobjectcode为success时有,接口业务数据

业务响应参数

参数类型是否必填描述
sub_codestring业务返回码,success或fail
sub_msgstring业务返回码描述
sub_dataobjectsub_code为success时显示
+tokenstring

type为getscancode时必填

当前扫码图片唯一标识

+qrcodestring

type为getscancode时必填

扫码图片

+statusstring

type为checktoken时必填

用户扫码状态

+uidstring

type为checktoken时必填

用户唯一标识,仅用户确认后才返回,否则返回为空值