客户身份(CIAM)

微信小程序登录

使用微信小程序登录时调用本接口。

# 请求说明

POST https://{your_domain}/api/v2/sdk/login/wechat-miniprogram

# 请求头

参数名 中文名称 必须 类型 示例
X-operating-sys-version 调用方客户端操作系统版本 String windows10.1.1
X-device-fingerprint 调用方客户端设备指纹 String 156aysdna213sc50
X-device-ip 调用方客户端IP String 192.168.1.2
X-agent User-Agent信息 String Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X)
X-L 用于国际化语言设置 String zh
X-client-id 应用授权ID String nTo1eRIub60vPb54WeE6aojPwYwImtl4
content-type 内容格式类型 String application/json

# 请求示例

{
    "code":" 091zQTFa1i6qMC02AWFa1Vzt0O0zQTF8"
}
1
2
3

# 请求参数

参数名 中文名称 必须 类型 描述
code 微信小程序登录码 String 微信小程序login返回的登录码

# 返回示例

成功示例1(成功匹配用户返回session_token、id_token):
HTTP/1.1 200 OK
Content-Type: application/json
{
    "session_token": "btsiBjx85prcZu6I6Ki057Tmw3nSF2VO",
    "expire": 432000,
    "status": "SUCCESS",
    "id_token": "eyJraWQn0.eyJpc3MiOiJodHR…g1A7jG8O0uw"
}

成功示例2(返回自动注册并绑定流程):
HTTP/1.1 200 OK
Content-Type: application/json
{
    "state_token": "eyJhbGcCJ9.eyJzdWMCJ9…tL2VPS8",
    "data": null,
    "status": "USER_REGISTER"
}

成功示例3(返回绑定流程):
HTTP/1.1 200 OK
Content-Type: application/json
{
    "state_token": " eyJhbGcCJ9.eyJzdWMCJ9…tL2VPS8",
    "data": null,
    "status": " SOCIAL_BIND"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# 返回参数

参数名 中文名称 类型 描述
status 登录流程状态标识 String SUCCES: 登录成功
SOCIAL_BIND: 绑定流程。选择一种方式绑定:
微信授权手机绑定用户;
其它手机绑定用户;
用户名和密码绑定用户
USER_REGISTER: 绑定或注册流程。 选择一种方式绑定:
微信授权手机绑定或注册用户;
其它手机绑定或注册用户
ACCESS_DENIED:拒绝访问
MFA_AUTH: 二次认证
expire session_token有效期 Number Session_token有效期
session_token 用户session_token String 用户session_token
state_token 登录状态token String 带有状态的令牌,用于将微信的openid绑定到用户手机号或用户名流程
id_token 登录用户的身份令牌,短期有效 String 该字段为jwt格式,包含用户身份信息。可参考根据id_token获取用户信息获取用户信息。令牌有效期默认为5分钟。