From 96c834f5d15a67946dce19851b893b59acc51e27 Mon Sep 17 00:00:00 2001 From: wangyaqi Date: Thu, 1 Jul 2021 15:48:04 +0800 Subject: [PATCH] docs: uni-id --- docs/uniCloud/uni-id.md | 114 +++++++++++++++++++++++++++++----------- 1 file changed, 84 insertions(+), 30 deletions(-) diff --git a/docs/uniCloud/uni-id.md b/docs/uniCloud/uni-id.md index 36f46ccfe..6ae6896de 100644 --- a/docs/uniCloud/uni-id.md +++ b/docs/uniCloud/uni-id.md @@ -1571,19 +1571,23 @@ exports.main = async function(event,context) { **响应参数** -| 字段 | 类型 | 必填| 说明 | -| --- | --- | --- | --- | -| code | Number | 是 |错误码，0表示成功 | -| message | String | 是 |详细信息 | -| uid | String | 是 |用户uid | -| type | String | 是 |操作类型，`login`为登录、`register`为注册| -| openid | String | 是 |用户openid | -| unionid | String | 否 |用户unionid，能取到此参数时会返回 | -| token | String | 是 |登录成功之后返回的token信息 | -| userInfo | Object | 否 |用户全部信息，`type`为`login`时返回 | -| tokenExpired | String | 是 |token过期时间 | -| mobileConfirmed | Boolean | 是 |是否已验证手机号 | -| emailConfirmed | Boolean | 是 |是否已验证邮箱 | +| 字段 | 类型 | 必填| 说明 | +| --- | --- | --- | --- | +| code | Number | 是 |错误码，0表示成功 | +| message | String | 是 |详细信息 | +| uid | String | 是 |用户uid | +| type | String | 是 |操作类型，`login`为登录、`register`为注册 | +| openid | String | 是 |用户openid | +| unionid | String | 否 |用户unionid，能取到此参数时会返回 | +| token | String | 是 |登录成功之后返回的token信息 | +| userInfo | Object | 否 |用户全部信息，`type`为`login`时返回 | +| tokenExpired | String | 是 |token过期时间 | +| mobileConfirmed | Boolean | 是 |是否已验证手机号 | +| emailConfirmed | Boolean | 是 |是否已验证邮箱 | +| sessionKey | String | - |客户端为微信小程序时返回 | +| accessToken | String | - |客户端为APP时返回，微信接口调用凭证，新增于`uni-id 3.1.1` | +| refreshToken | String | - |客户端为APP时返回，用于刷新accessToken，新增于`uni-id 3.1.1` | +| expired | Number | - |客户端为APP时返回，accessToken 接口调用凭证超时时间对应的时间戳，新增于`uni-id 3.1.1`| **示例代码** @@ -1674,6 +1678,8 @@ export default { ``` ### 获取微信openid + +> 此接口即将废弃 用法：`uniID.code2SessionWeixin(Object Code2SessionWeixinParams);` @@ -1688,13 +1694,14 @@ export default { | 字段 | 类型 | 必填| 说明 | | --- | --- | --- | --- | | code | Number| 是 |错误码，0表示成功 | -| message | String| 是 |详细信息 | +| message | String| 是 |详细信息 | | openid | String| - |用户openid | | unionid | String| - |用户unionid，可以取到此值时返回 | | sessionKey | String| - |客户端为微信小程序时返回 | | accessToken | String| - |客户端为APP时返回 | -| expiresIn | String| - |客户端为APP时返回，accessToken 接口调用凭证超时时间，单位（秒）| -| refreshToken| String| - |客户端为APP时返回，用于刷新accessToken | +| refreshToken| String| - |客户端为APP时返回，用于刷新accessToken | +| expired | Number| - |客户端为APP时返回，accessToken 接口调用凭证超时时间对应的时间戳，新增于`uni-id 3.1.1`| +| expiresIn | Number| - |客户端为APP时返回，accessToken 接口调用凭证过期时间，单位（秒）| ```js // 云函数代码 @@ -1720,10 +1727,16 @@ exports.main = async function(event,context) { **响应参数** -| 字段| 类型 | 必填| 说明 | -| --- | --- | --- | --- | -| code| Number| 是 |错误码，0表示成功| -| message | String| 是 |详细信息 | +| 字段 | 类型 | 必填| 说明 | +| --- | --- | --- | --- | +| code | Number| 是 |错误码，0表示成功 | +| message | String| 是 |详细信息 | +| openid | String| 是 |用户openid | +| unionid | String| 否 |用户unionid，能取到此参数时会返回 | +| sessionKey | String| - |客户端为微信小程序时返回，新增于`uni-id 3.1.1` | +| accessToken | String| - |客户端为APP时返回，微信接口调用凭证，新增于`uni-id 3.1.1` | +| refreshToken| String| - |客户端为APP时返回，用于刷新accessToken，新增于`uni-id 3.1.1` | +| expired | Number| - |客户端为APP时返回，accessToken 接口调用凭证超时时间对应的时间戳，新增于`uni-id 3.1.1`| ```js // 云函数代码 @@ -1772,6 +1785,8 @@ exports.main = async function(event,context) { ``` ### 微信数据解密 + +> 此接口即将废弃 用法：`uniID.wxBizDataCrypt(Object WxBizDataCryptParams);` @@ -1817,19 +1832,19 @@ exports.main = async function(event,context) { **LoginByAlipayParams参数说明** -| 字段 | 类型 | 必填| 说明 | -| --- | --- | --- | --- | -| code | String| 是 |支付宝登录返回的code | -| myInviteCode| String| 否 |设置当前注册用户自己的邀请码，type为`register`时生效 | +| 字段 | 类型 | 必填| 说明 | +| --- | --- | --- | --- | +| code | String | 是 |支付宝登录返回的code | +| myInviteCode | String | 否 |设置当前注册用户自己的邀请码，type为`register`时生效 | | needPermission| Boolean | 否 |设置为true时会在checkToken时返回用户权限（permission），建议在管理控制台中使用 | -| role | Array | 否 |设定用户角色 ，当前用户为新注册时生效 | +| role | Array | 否 |设定用户角色，当前用户为新注册时生效 | **响应参数** | 字段 | 类型 | 必填| 说明 | | --- | --- | --- | --- | | code | Number | 是 |错误码，0表示成功 | -| message | String | 是 |详细信息 | +| message | String | 是 |详细信息 | | uid | String | 是 |用户uid | | type | String | 是 |操作类型，`login`为登录、`register`为注册| | openid | String | 是 |用户openid | @@ -1856,6 +1871,8 @@ exports.main = async function(event,context) { ### 获取支付宝用户ID + +> 此接口即将废弃 用法：`uniID.code2SessionAlipay(Object Code2SessionAlipayParams);` @@ -2076,6 +2093,8 @@ export default { ``` ### Apple登录校验identityToken + +> 此接口即将废弃 用法：`uniID.verifyAppleIdentityToken(Object Code2SessionAppleParams);` @@ -2690,9 +2709,44 @@ exports.main = async function(event,context) { - 任务表：uni-id-task - 任务日志表：uni-id-task-log -# 错误码 - -自`1.1.0`版本使用此错误码规范 +# 错误码@errcode + +**自`3.1.1`版本起使用此错误码规范** + +自`3.1.1`版本起uni-id使用errCode作为错误码，errMsg作为错误信息，为兼容旧版本，code、message字段仍保留。 + +errCode和errMsg对照表如下： + +|错误码（errCode） |详细信息（errMsg） |说明 | +|--- |--- |--- | +|0 |成功 |操作成功 | +|uni-id-account-banned |账号已禁用 |账号已禁用 | +|uni-id-user-not-exist |用户不存在 |用户不存在 | +|uni-id-multi-user-matched |匹配到多个账号 |匹配到多个账号 | +|uni-id-password-error |密码错误 |密码错误 | +|uni-id-password-error-exceed-limit |密码错误次数过多 |密码错误次数过多 | +|uni-id-account-already-registed |此{type}已注册 |此账号已注册、包括手机号、微信等 | +|uni-id-account-not-registed |此{type}尚未注册 |此账号尚未注册、包括手机号、微信等 | +|uni-id-invalid-invite-code |邀请码无效 |邀请码无效 | +|uni-id-get-third-party-account-failed |获取{account}失败 |获取三方平台账号失败 | +|uni-id-param-required |{param}不可为空 |字段不可为空 | +|uni-id-check-device-feature-failed |设备特征校验未通过 |设备特征校验未通过 | +|uni-id-token-not-exist |云端已不包含此token |云端已不包含此token | +|uni-id-token-expired |token已过期 |token已过期 | +|uni-id-check-token-failed |token校验未通过 |token校验未通过 | +|uni-id-invalid-old-password |旧密码错误 |旧密码错误 | +|uni-id-param-error |{param}参数错误，{reason}|参数错误 | +|uni-id-invalid-verify-code |验证码错误或已失效 |验证码错误或已失效 | +|uni-id-send-sms-code-failed |验证码发送失败 |验证码发送失败 | +|uni-id-account-already-bound |此{type}已绑定 |此账号已绑定、包括手机号、微信等 | +|uni-id-unbind-failed |解绑失败 |解绑失败 | +|uni-id-set-invite-code-failed |邀请码设置失败 |邀请码设置失败 | +|uni-id-modify-invite-code-is-not-allowed |邀请码不可修改 |邀请码不可修改 | +|uni-id-database-operation-failed |数据库读写异常 |数据库读写异常 | +|uni-id-role-not-exist |角色不存在 |角色不存在 | +|uni-id-permission-not-exist |权限不存在 |权限不存在 | + +**自`1.1.0`版本使用此错误码规范** |模块 |模块码 |错误代码 |错误信息 | |:-: |:-: |:-: |:-: | @@ -2768,7 +2822,7 @@ exports.main = async function(event,context) { | | |06 |（80806）iv不可为空 | |`公用码` |900 |01 |（90001）数据库读写异常 | -**另外还有一些字符串类型的扩展错误码在各自接口的文档中展示，请不要直接使用`code>0`这种方式来判断是否有错误，建议使用`if(code){}`来判断是否有错误** +**另外还有一些字符串类型的扩展错误码在各自接口的文档中展示，请不要直接使用`code>0`这种方式来判断是否有错误，建议使用`if(code){}`来判断是否有错误** # 其他功能 -- GitLab