Skip to content

U
uni-app

DCloud / uni-app
4 个月 前同步成功

通知 725
Star 38705
Fork 3642
U
uni-app

体验新版 GitCode，发现更多精彩内容 >>

提交 4b91682e 编写于 作者: 雪洛's avatar 雪洛
浏览文件
操作

docs: uni-id

上级 c67bc383
隐藏空白更改
内联 并排
Showing with 99 addition and 21 deletion
docs/uniCloud/uni-id.md
浏览文件 @ 4b91682e
...@@ -908,7 +908,7 @@ exports.main = async function(event,context) { ...@@ -908,7 +908,7 @@ exports.main = async function(event,context) {
- 需要在config.json内使用微信登录的平台下配置appid和appsecret - 需要在config.json内使用微信登录的平台下配置appid和appsecret
- uniId会自动判断客户端平台 - uniId会自动判断客户端平台
- 登录成功之后应持久化存储token，键值为：uniIdToken，`uni.removeStorageSync('uniIdToken')` - 登录成功之后应持久化存储token，键值为：uniIdToken，`uni.setStorageSync('uniIdToken', res.result.token)`
- App端获取code不可直接调用`uni.login`，详细用法可以看下面示例 - App端获取code不可直接调用`uni.login`，详细用法可以看下面示例
**参数说明** **参数说明**
...@@ -921,16 +921,18 @@ exports.main = async function(event,context) { ...@@ -921,16 +921,18 @@ exports.main = async function(event,context) {
**响应参数** **响应参数**
| 字段 | 类型 | 必填| 说明 | | 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| code | Number| 是 |错误码，0表示成功 | | code | Number | 是 |错误码，0表示成功 |
| msg | String| 是 |详细信息 | | msg | String | 是 |详细信息 |
| uid | String| 是 |用户uid | | uid | String | 是 |用户uid |
| type | String| 是 |操作类型，`login`为登录、`register`为注册| | type | String | 是 |操作类型，`login`为登录、`register`为注册|
| openid | String| 是 |用户openid | | openid | String | 是 |用户openid |
| unionid | String| 否 |用户unionid，能取到此参数时会返回 | | unionid | String | 否 |用户unionid，能取到此参数时会返回 |
| token | String| - |登录成功之后返回的token信息 | | token | String | 是 |登录成功之后返回的token信息 |
| tokenExpired| String| - |token过期时间 | | tokenExpired | String | 是 |token过期时间 |
| mobileConfirmed | Boolean | 是 |是否已验证手机号 |
| emailConfirmed | Boolean | 是 |是否已验证邮箱 |
**示例代码** **示例代码**
...@@ -1019,6 +1021,41 @@ export default { ...@@ -1019,6 +1021,41 @@ export default {
``` ```
## 获取微信openid
用法：`uniID.code2SessionWeixin(Object Code2SessionWeixinParams);`
**参数说明**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | String| 是 |微信登录返回的code |
|platform |String |否 |客户端类型：`mp-weixin`、`app-plus`，默认uni-id会自动取客户端类型，但是在云函数url化等场景无法取到客户端类型，可以使用此参数指定 |
**响应参数**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | Number| 是 |错误码，0表示成功 |
| msg | String| 是 |详细信息 |
| openid | String| - |用户openid |
| unionid | String| - |用户unionid，可以取到此值时返回 |
| sessionKey | String| - |客户端为微信小程序时返回 |
| accessToken | String| - |客户端为APP时返回 |
| expiresIn | String| - |客户端为APP时返回，accessToken 接口调用凭证超时时间，单位（秒）|
| refreshToken| String| - |客户端为APP时返回，用于刷新accessToken |
```js
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
const res = await uniID.code2SessionWeixin({
code: event.code
})
return res
}
```
## 绑定微信 ## 绑定微信
用法：`uniID.bindWeixin(Object weixinInfo);` 用法：`uniID.bindWeixin(Object weixinInfo);`
...@@ -1093,7 +1130,7 @@ exports.main = async function(event,context) { ...@@ -1093,7 +1130,7 @@ exports.main = async function(event,context) {
**注意** **注意**
- 需要在config.json内支付宝平台下配置appid和privateKey（应用私钥） - 需要在config.json内支付宝平台下配置appid和privateKey（应用私钥）
- 登录成功之后应持久化存储token，键值为：uniIdToken，`uni.removeStorageSync('uniIdToken')` - 登录成功之后应持久化存储token，键值为：uniIdToken，`uni.setStorageSync('uniIdToken', res.result.token)`
**参数说明** **参数说明**
...@@ -1105,15 +1142,17 @@ exports.main = async function(event,context) { ...@@ -1105,15 +1142,17 @@ exports.main = async function(event,context) {
**响应参数** **响应参数**
| 字段 | 类型 | 必填| 说明 | | 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| code | Number| 是 |错误码，0表示成功 | | code | Number | 是 |错误码，0表示成功 |
| msg | String| 是 |详细信息 | | msg | String | 是 |详细信息 |
| uid | String| 是 |用户uid | | uid | String | 是 |用户uid |
| type | String| 是 |操作类型，`login`为登录、`register`为注册| | type | String | 是 |操作类型，`login`为登录、`register`为注册|
| openid | String| 是 |用户openid | | openid | String | 是 |用户openid |
| token | String| - |登录成功之后返回的token信息 | | token | String | 是 |登录成功之后返回的token信息 |
| tokenExpired| String| - |token过期时间 | | tokenExpired | String | 是 |token过期时间 |
| mobileConfirmed | Boolean | 是 |是否已验证手机号 |
| emailConfirmed | Boolean | 是 |是否已验证邮箱 |
**示例代码** **示例代码**
...@@ -1129,6 +1168,41 @@ exports.main = async function(event,context) { ...@@ -1129,6 +1168,41 @@ exports.main = async function(event,context) {
return res return res
} }
``` ```
## 获取微信openid
用法：`uniID.code2SessionWeixin(Object Code2SessionWeixinParams);`
**参数说明**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | String| 是 |微信登录返回的code |
|platform |String |否 |客户端类型：`mp-weixin`、`app-plus`，默认uni-id会自动取客户端类型，但是在云函数url化等场景无法取到客户端类型，可以使用此参数指定 |
**响应参数**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | Number| 是 |错误码，0表示成功 |
| msg | String| 是 |详细信息 |
| openid | String| - |用户openid |
| accessToken | String| - |客户端为APP时返回 |
| expiresIn | String| - |客户端为APP时返回，accessToken 接口调用凭证超时时间，单位（秒）|
| refreshToken| String| - |客户端为APP时返回，用于刷新accessToken |
| reExpiresIn | String| - |refreshToken超时时间，单位（秒） |
```js
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
const res = await uniID.code2SessionWeixin({
code: event.code
})
return res
}
```
## 绑定支付宝 ## 绑定支付宝
...@@ -1588,6 +1662,10 @@ exports.main = async function(event,context) { ...@@ -1588,6 +1662,10 @@ exports.main = async function(event,context) {
|填写邀请人邀请码 |805 |01 |邀请码无效（邀请码存在且唯一时才算有效） | |填写邀请人邀请码 |805 |01 |邀请码无效（邀请码存在且唯一时才算有效） |
| | |02 |uid错误，用户不存在 | | | |02 |uid错误，用户不存在 |
| | |03 |邀请码不可修改 | | | |03 |邀请码不可修改 |
|获取微信openid |806 |01 |未能获取openid |
| | |02 |调用获取openid接口失败 |
|获取支付宝openid |807 |01 |未能获取openid |
| | |02 |调用获取openid接口失败 |
|公用码 |900 |01 |数据库读写异常 | |公用码 |900 |01 |数据库读写异常 |
# FAQ # FAQ
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或