客户端API总览
竹云IDaaS平台提供所有的客户端API列表，调用平台API前，需了解开发前须知及调用流程。本文提供所有针对不同客户端场景的开放API，供开发者参考。
通用验证码
| API接口名 | API路径 | API说明 |
|---|---|---|
| 获取图形验证码 | /api/v2/sdk/captcha | 用于人机校验的初始化图形验证码 |
| 校验图形验证码 | /api/v2/sdk/captcha/verify | 滑动图形验证码滑块后，调用校验图形验证码 |
| 获取国际区号 | /api/v2/sdk/country-codes | 查询服务端支持的国际区号 |
| 发送短信验证码 | /api/v2/sdk/sms/send | 人机校验通过后，调用发送短信验证码接口 |
| 发送邮箱验证码 | /api/v2/sdk/email/send | 人机校验通过后，调用发送邮箱验证码接口 |
登录
| API接口名 | API路径 | API说明 |
|---|---|---|
| 用户名密码登录 | /api/v2/sdk/login | 使用用户名和密码进行登录 |
| 手机号密码登录 | /api/v2/sdk/login/mobile-pwd | 使用手机号和密码进行登录 |
| 邮箱密码登录 | /api/v2/sdk/login/email-pwd | 使用邮箱和密码进行登录 |
| 邮箱验证码登录 | /api/v2/sdk/login/email-verify-code | 使用邮箱和邮件验证码进行登录 |
| 统一用户密码登录 | /api/v2/sdk/login/auth | 使用用户统一用户（用户名/手机/邮箱）和密码进行登录认证 |
| 手机短信登录 | /api/v2/sdk/login/mobile-verify-code | 使用手机和短信进行登录 |
| 手机微信授权登录 | /api/v2/sdk/login/wechat | 使用手机微信授权登录 |
| 手机支付宝授权登录 | /api/v2/sdk/login/alipay | 使用手机支付宝授权登录 |
| QQ授权登录 | /api/v2/sdk/login/qq | 使用QQ登录 |
| 微博授权登录 | /api/v2/sdk/login/weibo | 使用微信登录 |
| Apple授权登录 | /api/v2/sdk/login/apple | 使用Apple登录 |
| 微信小程序登录 | /api/v2/sdk/login/wechat-miniprogram | 使用微信小程序进行登录 |
| 支付宝小程序登录 | /api/v2/sdk/login/alipay-miniprogram | 使用支付宝小程序进行登录 |
| 手机号一键登录 | /api/v2/sdk/login/aliyun-mobile-auth | 使用手机一键登录 |
社交账号
| API接口名 | API路径 | API说明 |
|---|---|---|
| 社交账号绑定手机号或邮箱 | /api/v2/sdk/social/bind | 用于社交账号绑定手机号或邮箱操作 |
| 社交账号登录即注册手机号或邮箱 | /api/v2/sdk/social/register-bind | 用户未绑定系统手机号并用社交账号登录 |
| 微信小程序授权手机登录即注册用户 | /api/v2/sdk/social/wechat-mobile-register-bind | 若用户在平台不存在时，创建一个与微信小程序授权的相同手机号的用户并与微信绑定；否则使用已存在的用户与微信绑定； |
| 使用微信小程序授权手机绑定用户 | /api/v2/sdk/social/wechat-mobile-bind | 只有用户已在平台中存在手机号时，使用微信小程序授权的相同手机号与微信绑定成功。 |
| 使用支付宝授权手机登录即注册用户 | /api/v2/sdk/social/alipay-mini-mobile-register-bind | 若用户在平台不存在时，创建一个与支付宝小程序授权的相同手机号的用户并与支付宝绑定；否则使用已存在的用户与支付宝绑定； |
| 使用支付宝授权手机绑定用户 | /api/v2/sdk/social/alipay-mini-mobile-bind | 只有用户已在平台中存在手机号时，使用支付宝小程序授权的相同手机号与支付宝可绑定成功。 |
| 获取已绑定社交账号列表 | /api/v2/sdk/social | 用于获取用户已绑定的社交账号 |
| 社交账号解绑 | /api/v2/sdk/social/unbind-account | 用于社交账号解绑操作 |
密码管理
| API接口名 | API路径 | API说明 |
|---|---|---|
| 跳过强制修改密码 | /api/v2/sdk/pwd/skip-update | 如果密码快过期，并且用户选择跳过修改密码 |
| 强制修改密码 | /api/v2/sdk/pwd/update | 如果密码已过期或者密码快过期，用户选择修改密码 |
| 查询是否设置密码 | /api/v2/sdk/pwd/check-exist | 修改个人密码时，调用本接口获取用户是否设置密码 |
| 修改密码 | /api/v2/sdk/pwd/change | 用户登录后修改自己的密码 |
| 手机号找回密码 | /api/v2/sdk/pwd/update-by-mobile | 在用户忘记密码时，选择通过手机号找回密码 |
| 邮箱找回密码 | /api/v2/sdk/pwd/update-by-email | 在用户忘记密码时，选择通过邮箱找回密码 |
自服务
| API接口名 | API路径 | API说明 |
|---|---|---|
| 手机短信注册用户 | api/v2/sdk/register/mobile-verify-code | 使用手机和短信验证码进行用户注册 |
| 邮箱验证码注册用户 | api/v2/sdk/register/email-verify-code | 使用邮箱和验证码进行用户注册 |
| 修改个人信息 | /api/v2/sdk/profile/update | 用户登录成功后修改个人信息 |
| 修改个人手机号 | /api/v2/sdk/profile/update-mobile | 用户登录成功后，修改个人手机号 |
| 修改个人邮箱 | /api/v2/sdk/profile/update-email | 用户登录成功后，修改个人邮箱 |
| 微信授权手机更新用户手机 | /api/v2/sdk/profile/update-mobile-by-wechat | 用户手机未绑定时，调用此接口可将当前用户手机号更新为微信授权手机号 |
| 退出登录 | /api/v2/sdk/logout | 退出当前的登录 |
| 用户注销 | /api/v2/sdk/logoff | 用户注销时调用本接口，将用户彻底从系统中清除 |
Token管理
| API接口名 | API路径 | API说明 |
|---|---|---|
| id Token刷新 | /api/v2/sdk/sso/session-token/id-token | 对id_token进行刷新 |