uni-id.md 59.6 KB
Newer Older
雪洛's avatar
雪洛 已提交
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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
# 需求背景

99%的应用,都要开发用户注册、登录、发送短信验证码、密码加密保存、修改密码、token管理等功能,从前端到后端都需要。

为什么不能有一个开源的通用项目,避免大家的重复开发呢?

`uni-id`应需而生。

`uni-id``uniCloud`开发者提供了简单、统一、可扩展的用户管理能力封装。

# 组成部分
`uni-id`包括如下组成部分:
1. 云数据库

主表为 `uni-id-users` 表,保存用户的基本信息。

扩展字段有很多,如实名认证数据、工作履历数据,开发者可以自由扩展。

2. 云函数

提供一个名为`uni-id`的公共模块,该模块封装了一系列API,包括注册、登录、修改密码、设置头像等。

示例工程中还提供了一个`user-center`的云函数,演示在云函数中如何调用`uni-id`公共模块。

3. 前端调用

前端示例通过callfunction调用云函数`user-center`,在注册和登录时保存token。

uniCloud框架底层,会自动在callfunction时传递`uni-id`的token(uni-app 2.7.13+版本)。在云函数的event中可直接拿到`uni-id`的token。也就是说开发者无需自己管理token了。

# uni-id 对开发者的价值
1. 节省了大量重复劳动
2. 降低门槛,前端开发者无需纠结怎样设计数据库设计才更合理
3. 多系统打通用户和上下游协同

关于第三点,着重强调下。

一个应用,往往需要集成多个功能模块。比如一个电商应用,需要一个基本电商模板,还需要客服聊天模板,甚至还需要用户交流社区。

在插件市场,每类模板插件都能找到,但他们如果不是基于同一套用户体系设计,就很难整合。

DCloud推荐所有uniCloud的应用,都基于`uni-id`来做。

有了统一的账户规范,并且围绕这套账户规范,有各种各样插件,那么开发者可以随意整合这些插件,让数据连同。

规范,还可以让上下游充分协同。插件市场会出现各种数据迁移插件,比如把从discuz里把用户迁移到`uni-id`中的插件,相信围绕这套规范的产业链会非常活跃。

# 现状和未来

`uni-id`已完整的内容:

- 注册、登录、发送短信验证码、密码加密保存、修改密码、token管理(短信验证码功能需要HBuilderX 2.8.3+)
- 三方登录:App中的微信登录、微信小程序中的微信登录、支付宝小程序中的支付宝账户登录 

关于还缺少的部分,哪些DCloud在完善,哪些希望开发者给共同完善开源项目,计划与边界公布如下:

1. 部分社交账户登录

DCloud暂无计划开发百度、头条、QQ等小程序的登录,以及Apple ID、微博、QQ等App端的登录。欢迎其他开发者在开源项目上提交pr,共同完善`uni-id`

2. 邮箱验证和手机号一键认证sdk集成

手机号一键认证sdk,目前插件市场里已经有不少相关插件,未来DCloud会整合到`uni-id`中。邮箱验证,DCloud暂无计划开发,有需求的开发者欢迎提供pr。

3. 实名认证、活体检测

目前插件市场里已经有不少相关插件,未来DCloud会整合到`uni-id`中。

4. 权限管理ACL

这部分欢迎开发者参与完善。

其他方面,各种常见开源项目如discuz、wordPress、ecshop的用户导入插件,不属于`uni-id`主工程,欢迎开发者单独提交插件到插件市场。

`uni-id`的git仓库:[https://gitee.com/dcloud/uni-id.git](https://gitee.com/dcloud/uni-id.git)


# 快速上手

使用uni-id需要按照以下步骤操作

1. 准备2.7.14或以上版本的HBuilderX
2. 插件市场导入`uni-id`公用模块,[插件市场 uni-id](https://ext.dcloud.net.cn/plugin?id=2116)
3. 修改公用模块`uni-id`下的`config.json`内所需参数(请参考下面config.json的说明)
4. 上传`cloudfunctions/common`下的`uni-id`模块
雪洛's avatar
雪洛 已提交
86
5. 按照[公用模块使用说明](https://uniapp.dcloud.io/uniCloud/cf-common)在云函数下安装`uni-id`模块
雪洛's avatar
雪洛 已提交
87 88 89 90 91
6. 创建`uni-id-users``uni-verify`集合(可以直接使用示例项目里面的db_init.json进行初始化)

或者直接导入[uni-id在插件市场的示例工程](https://ext.dcloud.net.cn/plugin?id=2116)

导入示例项目时,如果选择腾讯云,在HBuilderX2.7及以下版本中,需要进入项目目录,手动将目录`cloudfunctions-aliyun`改名为`cloudfunctions-tcb`,然后在HBuilderX中右键cloudfunctions绑定服务空间。
雪洛's avatar
雪洛 已提交
92 93 94

**config.json的说明**

雪洛's avatar
雪洛 已提交
95 96 97 98
注意:

- **config.json是一个标准json文件,不支持注释**
- 如果不希望使用config.json初始化而是想自行传入参数,可以使用`init`方法[uniID.init](/uniCloud/uni-id?id=init)
雪洛's avatar
雪洛 已提交
99 100 101

配置项:

雪洛's avatar
雪洛 已提交
102 103
+ `passwordSecret`为用于加密密码入库的密钥
+ `tokenSecret`为生成token需要的密钥
雪洛's avatar
雪洛 已提交
104 105 106 107 108 109
+ `tokenExpiresIn`token有效期,以秒为单位
+ `passwordErrorLimit`密码错误重试次数,分ip记录密码错误次数,达到重试次数之后等待`passwordErrorRetryTime`时间之后才可以重试
+ `passwordErrorRetryTime`单位为秒
+ 如果使用`sendSmsCode`接口发送短信需要前往[https://dev.dcloud.net.cn/uniSms](https://dev.dcloud.net.cn/uniSms)充值短信额度,配置`config.json``service`字段,字段说明见下方示例
+ 如果使用其他方式发送短信可以参考`sendSmsCode`接口的实现[uni-id sendSmsCode](https://gitee.com/dcloud/uni-id/blob/master/src/lib/send-sms-code.js)
+ 另外可以按照客户端平台进行不同的配置,参考下面示例
雪洛's avatar
雪洛 已提交
110 111

**下面的配置文件中所有时间的单位都是秒**
雪洛's avatar
雪洛 已提交
112 113 114 115

```json
// 如果拷贝此内容切记去除注释
{
雪洛's avatar
雪洛 已提交
116 117
	"passwordSecret": "passwordSecret-demo", // 加密密码所用的密钥,注意修改为自己的,使用一个较长的字符串即可
	"tokenSecret": "tokenSecret-demo", // 生成token所用的密钥,注意修改为自己的,使用一个较长的字符串即可
雪洛's avatar
雪洛 已提交
118
	"tokenExpiresIn": 7200, // 全平台token过期时间,未指定过期时间的平台会使用此值
雪洛's avatar
雪洛 已提交
119
	"tokenExpiresThreshold": 600, // 新增于uni-id 1.1.7版本,checkToken时如果token有效期小于此值则自动获取新token,请注意将新token返回给前端保存,如果不配置此参数则不开启自动获取新token功能
雪洛's avatar
雪洛 已提交
120
	"bindTokenToDevice": true, // 是否将token和设备绑定,设置为true会进行ua校验,默认为true
雪洛's avatar
雪洛 已提交
121
	"passwordErrorLimit": 6, // 密码错误最大重试次数
雪洛's avatar
雪洛 已提交
122 123 124 125
	"passwordErrorRetryTime": 3600, // 密码错误重试次数超限之后的冻结时间
  "autoSetInviteCode": false, // 是否在用户注册时自动设置邀请码,默认不自动设置
  "forceInviteCode": false, // 是否强制用户注册时必填邀请码,默认为false(需要注意的是目前只有短信验证码注册才可以填写邀请码)
  "app-plus": {
雪洛's avatar
雪洛 已提交
126
		"tokenExpiresIn": 2592000,
雪洛's avatar
雪洛 已提交
127
		"oauth": {
雪洛's avatar
雪洛 已提交
128
			// App微信登录所用到的appid、appsecret需要在微信开放平台获取,注意:不是公众平台而是开放平台
雪洛's avatar
雪洛 已提交
129 130 131 132 133 134 135
			"weixin": {
				"appid": "weixin appid",
				"appsecret": "weixin appsecret"
			}
		}
	},
	"mp-weixin": {
雪洛's avatar
雪洛 已提交
136
		"oauth": {
雪洛's avatar
雪洛 已提交
137
			// 微信小程序登录所用的appid、appsecret需要在对应的小程序管理控制台获取
雪洛's avatar
雪洛 已提交
138 139 140 141 142 143 144
			"weixin": {
				"appid": "weixin appid",
				"appsecret": "weixin appsecret"
			}
		}
	},
	"mp-alipay": {
雪洛's avatar
雪洛 已提交
145
		"oauth": {
雪洛's avatar
雪洛 已提交
146
			// 支付宝小程序登录用到的appid、privateKey请参考支付宝小程序的文档进行设置或者获取,https://opendocs.alipay.com/open/291/105971#LDsXr
雪洛's avatar
雪洛 已提交
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
			"alipay": {
				"appid": "alipay appid",
				"privateKey": "alipay privateKey"
			}
		}
	},
	"service": {
		"sms": {
			"name": "your app name", // 应用名称,对应短信模版的name
			"codeExpiresIn": 180, // 验证码过期时间,单位为秒,注意一定要是60的整数倍
			"smsKey": "your sms key", // 短信密钥key,开通短信服务处可以看到
			"smsSecret": "your sms secret" // 短信密钥secret,开通短信服务处可以看到
		}
	}
}
```
W
wanganxp 已提交
163 164 165 166 167 168 169 170 171 172 173 174 175

# API列表

## 用户注册 @register

用法`uniID.register(Object user)`

**注意**

- 注册成功之后会返回token,在获取token之后应进行持久化存储,键值为:uniIdToken,`uni.setStorageSync('uniIdToken',res.result.token)`

**user参数说明**

雪洛's avatar
雪洛 已提交
176 177 178 179 180
| 字段					| 类型	| 必填| 说明								|
| ---						| ---		| ---	| ---									|
| username			| String| 是	|用户名,唯一					|
| password			| String| 是	|密码									|
| myInviteCode	| String| 否	|自行设置用户的邀请码	|
W
wanganxp 已提交
181 182 183 184 185 186 187 188 189 190 191 192 193 194

username可以是字符串、可以是email、可以是手机号,本插件不约束,开发者可以自己定。

比如要求username为手机号,则自行在前端界面上做好提示,在后台对格式进行校验。

password入库时会自动进行一次sha1加密,不明文存储密码。

**响应参数**

| 字段	| 类型	| 必填	| 说明						|
| ---	| ---	| ---	| ---						|
| code	| Number| 是	|错误码,0表示成功			|
| msg	| String| 是	|详细信息					|
| token	| String| -	|注册完成自动登录之后返回的token信息|
195
| tokenExpired	| String| -	|token过期时间|
W
wanganxp 已提交
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263

**示例代码**

```js
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		username,
		password
	} = event
	// username、password验证是否合法的逻辑
	const res = await uniID.register({
		username,
		password
	})
	return res
}
```

```js
// 客户端代码
uniCloud.callFunction({
	name: 'register',
	data: {
		username: 'username',
		password: 'user password'
	},
	success(res){
		if(res.result.code === 0) {
      // 目前版本是驼峰形式uniIdToken,后面会调整为蛇形uni_id_token(调整后会在一段时间内兼容驼峰)
			uni.setStorageSync('uniIdToken',res.result.token)
			// 其他业务代码,如跳转到首页等
			uni.showToast({
				title: '注册成功',
				icon: 'none'
			})
		} else {
			uni.showModal({
				content: res.result.msg,
				showCancel: false
			})
		}
	},
	fail(){
		uni.showModal({
			content: '注册失败,请稍后再试',
			showCancel: false
		})
	}
})
```


## 用户登录 @login

用法:`uniID.login(Object user)`

**注意**

- 登录成功之后会返回token,在获取token之后应进行持久化存储,键值为:uniIdToken,`uni.setStorageSync('uniIdToken',res.result.token)`

**user参数说明**

| 字段		| 类型	| 必填	| 说明	|
| ---		| ---	| ---	| ---	|
| username	| String| 是	|用户名	|
| password	| String| 是	|密码	|
雪洛's avatar
雪洛 已提交
264
| queryField	| Array| 否	|指定从哪些字段中比对username,不填默认与数据库内的username字段对比, 可取值'username'、'email'、'mobile'|
W
wanganxp 已提交
265 266 267

**响应参数**

雪洛's avatar
雪洛 已提交
268 269 270 271 272 273 274 275
| 字段				| 类型	| 必填| 说明											|
| ---					| ---		| ---	| ---												|
| uid					| String| 是	|用户Id											|
| userInfo		| Object| 是	|用户全部信息								|
| code				| Number| 是	|错误码,0表示成功					|
| msg					| String| 是	|详细信息										|
| token				| String| -		|登录成功之后返回的token信息|
| tokenExpired| String| -		|token过期时间							|
W
wanganxp 已提交
276 277 278 279 280 281 282 283 284 285 286 287 288 289

**示例代码**

```js
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		username,
		password
	} = event
	// username、password验证是否合法的逻辑
	const res = await uniID.login({
		username,
雪洛's avatar
雪洛 已提交
290
		password,
雪洛's avatar
雪洛 已提交
291
    queryField: ['username', 'email', 'mobile']
W
wanganxp 已提交
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
	})
	return res
}
```

## token校验

用法:`uniID.checkToken(String token)`

**参数说明**

| 字段	| 类型	| 必填| 说明												|
| ---		| ---		| ---	| ---													|
| token	| String| 是	|客户端callFunction带上的token|

**响应参数**

雪洛's avatar
雪洛 已提交
309 310 311 312 313 314 315 316
| 字段				| 类型			| 说明																																													|
| ---					| ---				| ---																																														|
| code				| Number		|错误码,0表示成功																																							|
| msg					| String		|详细信息																																												|
| uid					| String		|用户Id,校验成功之后会返回																																			|
| token				| String		|新增于uni-id 1.1.7版本,用户token快要过期时,新生成的token,只有在config内配置了`tokenExpiresThreshold`的值时才会有此行为|
| tokenExpired| TimeStamp	|新增于uni-id 1.1.7版本,新token的过期时间																																							|
| userInfo		| Object		|用户信息,uid对应的uni-id-users全部字段																												|
W
wanganxp 已提交
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338

**注意:**

- 2.7.14+ 客户端会自动查找storage内的token在callFunction时插入
- 2.7.14 版本token存储在storage内使用的是驼峰形式的键值`uniIdToken`,下版会调整为蛇形`uni_id_token`,调整后会在一段时间内兼容驼峰形式

**示例代码**

```js
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const payload = await uniID.checkToken(event.uniIdToken)
	return payload
}
```

## 修改密码 @update-password

用法:`uniID.updatePwd(Object passwordInfo)`

**passwordInfo参数说明**

雪洛's avatar
雪洛 已提交
339 340 341 342 343 344
| 字段								| 类型	| 必填| 说明													|
| ---									| ---		| ---	| ---														|
| uid									| String| 是	|用户Id,可以通过checkToken返回	|
| oldPassword					| String| 是	|旧密码													|
| newPassword					| String| 是	|新密码													|
| passwordConfirmation| String| 是	|确认新密码											|
W
wanganxp 已提交
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

**响应参数**

| 字段	| 类型	| 必填	| 说明						|
| ---	| ---	| ---	| ---						|
| code	| Number| 是	|错误码,0表示成功			|
| msg	| String| 是	|详细信息					|

**示例代码**

```js
// 云函数update-pwd代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		oldPassword,
		newPassword,
		passwordConfirmation
	} = event
雪洛's avatar
雪洛 已提交
364 365 366 367 368 369
	// 校验新密码与确认新密码是否一致
  
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
雪洛's avatar
雪洛 已提交
370
  
雪洛's avatar
雪洛 已提交
371
	const res = await uniID.updatePwd({
雪洛's avatar
雪洛 已提交
372
    uid: payload.uid,
W
wanganxp 已提交
373 374 375 376 377 378 379 380
		oldPassword,
		newPassword,
		passwordConfirmation
	})
	return res
}
```

雪洛's avatar
雪洛 已提交
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
## 重置密码 @reset-password

用法:`uniID.resetPwd(Object passwordInfo)`

**passwordInfo参数说明**

| 字段								| 类型	| 必填| 说明													|
| ---									| ---		| ---	| ---														|
| uid									| String| 是	|用户Id,可以通过checkToken返回	|
| password					| String| 是	|重置后的密码													|

**响应参数**

| 字段	| 类型	| 必填	| 说明						|
| ---	| ---	| ---	| ---						|
| code	| Number| 是	|错误码,0表示成功			|
| msg	| String| 是	|详细信息					|

**示例代码**

```js
// 云函数代码
const uniID = require('uni-id')
雪洛's avatar
雪洛 已提交
404 405 406 407 408
exports.main = async function(event,context) {
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
雪洛's avatar
雪洛 已提交
409
  
雪洛's avatar
雪洛 已提交
410
	const res = await uniID.resetPwd({
雪洛's avatar
雪洛 已提交
411 412 413 414 415
    uid: payload.uid,
		password: '12345678'
	})
	return res
}
雪洛's avatar
雪洛 已提交
416
```
雪洛's avatar
雪洛 已提交
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440

## 加密密码 @encrypt-password

用法:`uniID.encryptPwd(String password)`

**passwordInfo参数说明**

| 字段								| 类型	| 必填| 说明													|
| ---									| ---		| ---	| ---														|
| password					| String| 是	|要加密的字符串													|

**响应参数**

| 字段	| 类型	| 必填	| 说明						|
| ---	| ---	| ---	| ---						|
| password	| String| 是	|加密后的字符串		|

**示例代码**

```js
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const encResult = await uniID.encryptPwd('123456')
雪洛's avatar
雪洛 已提交
441 442
	return {
    encResult
雪洛's avatar
雪洛 已提交
443 444
  }
}
雪洛's avatar
雪洛 已提交
445
```
雪洛's avatar
雪洛 已提交
446

W
wanganxp 已提交
447 448 449 450 451 452
## 设置头像

用法:`uniID.setAvatar(Object avatarInfo)`

**avatarInfo**参数说明

雪洛's avatar
雪洛 已提交
453 454 455 456
| 字段	| 类型	| 必填| 说明													|
| ---		| ---		| ---	| ---														|
| uid		| String| 是	|用户Id,可以通过checkToken返回	|
| avatar| String| 是	|用户头像URL										|
W
wanganxp 已提交
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| String| 是	|详细信息					|

**示例代码**

```js
// 云函数set-avatar代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		avatar
雪洛's avatar
雪洛 已提交
473 474 475 476
	} = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
雪洛's avatar
雪洛 已提交
477
  }
雪洛's avatar
雪洛 已提交
478
	const res = await uniID.setAvatar({
雪洛's avatar
雪洛 已提交
479
    uid: payload.uid,
W
wanganxp 已提交
480 481 482 483 484 485
		avatar
	})
	return res
}

```
雪洛's avatar
雪洛 已提交
486 487 488 489 490 491

## 发送短信验证码

用法:`uniID.sendSmsCode(Object codeInfo)`

**codeInfo**参数说明
雪洛's avatar
雪洛 已提交
492 493 494 495 496

| 字段	| 类型	| 必填| 说明													|
| ---		| ---		| ---	| ---														|
| mobile| String| 是	|用户手机号											|
| code		| String| 是	|验证码字符串	|
雪洛's avatar
雪洛 已提交
497
| type		| String| 是	|类型,用于防止不同功能的验证码混用,目前支持的类型`login`登录、`register`注册、`bind`绑定手机、`unbind`解绑手机	|
雪洛's avatar
雪洛 已提交
498 499 500 501 502 503

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
雪洛's avatar
雪洛 已提交
504
| msg	| String| 是	|详细信息					|
雪洛's avatar
雪洛 已提交
505 506 507 508 509 510 511 512 513

**示例代码**

```js
// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		mobile
雪洛's avatar
雪洛 已提交
514 515 516
	} = event
  // 生成验证码可以按自己的需求来,这里以生成6位数字为例
  const randomStr = '00000' + Math.floor(Math.random() * 1000000)
雪洛's avatar
雪洛 已提交
517 518
  const code = randomStr.substring(randomStr.length - 6)
	const res = await uniID.sendSmsCode({
雪洛's avatar
雪洛 已提交
519 520
		mobile,
    code,
雪洛's avatar
雪洛 已提交
521 522 523 524 525
    type: 'login'
	})
	return res
}

雪洛's avatar
雪洛 已提交
526 527 528 529 530 531 532 533 534
```

## 设置验证码

如果你不想使用`uni-id`的sendSmsCode发送短信的话,可以使用此接口自行在库中创建验证码

用法:`uniID.setVerifyCode(Object codeInfo)`

**codeInfo**参数说明
雪洛's avatar
雪洛 已提交
535 536 537 538 539

| 字段			| 类型	| 必填| 说明																																													|
| ---				| ---		| ---	| ---																																														|
| mobile		| String| 是	|用户手机号,和邮箱二选一																																										|
| email		| String| 是	|用户邮箱,和手机号二选一																																										|
雪洛's avatar
雪洛 已提交
540
| code			| String| 是	|验证码字符串																																										|
雪洛's avatar
雪洛 已提交
541
| expiresIn	| Number| 是	|验证码过期时间,单位秒																																					|
雪洛's avatar
雪洛 已提交
542
| type			| String| 是	|类型,用于防止不同功能的验证码混用,目前支持的类型`login`登录、`register`注册、`bind`绑定手机、`unbind`解绑手机|
雪洛's avatar
雪洛 已提交
543 544 545 546 547 548

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
雪洛's avatar
雪洛 已提交
549
| msg	| String| 是	|详细信息					|
雪洛's avatar
雪洛 已提交
550 551 552 553 554 555 556 557 558

**示例代码**

```js
// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		mobile
雪洛's avatar
雪洛 已提交
559 560 561
	} = event
  // 生成验证码可以按自己的需求来,这里以生成6位数字为例
  const randomStr = '00000' + Math.floor(Math.random() * 1000000)
雪洛's avatar
雪洛 已提交
562 563
  const code = randomStr.substring(randomStr.length - 6)
	const res = await uniID.setVerifyCode({
雪洛's avatar
雪洛 已提交
564 565 566
		mobile,
    code,
    expiresIn: 180,
雪洛's avatar
雪洛 已提交
567 568 569 570 571
    type: 'login'
	})
	return res
}

雪洛's avatar
雪洛 已提交
572 573 574 575 576 577 578 579 580
```

## 校验验证码

uni-id内置方法`loginBySms``bindMobile``unbindMobile`均已内置校验验证码方法,如果使用以上方法不需要再调用此接口,如需扩展类型请确保type和发送验证码/设置验证码时对应

用法:`uniID.verifyCode(Object codeInfo)`

**codeInfo**参数说明
雪洛's avatar
雪洛 已提交
581 582 583 584

| 字段	| 类型	| 必填| 说明																																													|
| ---		| ---		| ---	| ---																																														|
| mobile| String| 是	|用户手机号,和邮箱二选一																																				|
雪洛's avatar
雪洛 已提交
585
| email	| String| 是	|用户邮箱,和手机号二选一																																				|
雪洛's avatar
雪洛 已提交
586
| code	| String| 是	|验证码字符串																																										|
雪洛's avatar
雪洛 已提交
587
| type	| String| 是	|类型,用于防止不同功能的验证码混用,目前支持的类型`login`登录、`register`注册、`bind`绑定手机、`unbind`解绑手机|
雪洛's avatar
雪洛 已提交
588 589 590 591 592 593

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
雪洛's avatar
雪洛 已提交
594
| msg	| String| 是	|详细信息					|
雪洛's avatar
雪洛 已提交
595 596 597 598 599 600 601 602

**示例代码**

```js
// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
雪洛's avatar
雪洛 已提交
603
		mobile,
雪洛's avatar
雪洛 已提交
604 605 606
    code
	} = event
	const res = await uniID.verifyCode({
雪洛's avatar
雪洛 已提交
607 608
		mobile,
    code,
雪洛's avatar
雪洛 已提交
609 610 611 612 613
    type: 'login'
	})
	return res
}

雪洛's avatar
雪洛 已提交
614 615 616 617 618
```

## 手机号验证码直接登录

用法:`uniID.loginBySms(Object mobileInfo)`
雪洛's avatar
雪洛 已提交
619 620 621

**mobileInfo**参数说明

雪洛's avatar
雪洛 已提交
622 623 624 625 626 627 628 629
| 字段				| 类型	| 必填| 说明																																																	|
| ---					| ---		| ---	| ---																																																		|
| mobile			| String| 是	|用户手机号																																															|
| code				| String| 是	|验证码																																																	|
| type				| String| 否	|指定操作类型,可选值为`login``register`,不传此参数时表现为手机号已注册则登录,手机号未注册则进行注册|
| password		|String	| 否	|密码,type为`register`时生效																																						|
| inviteCode	|String	| 否	|邀请人的邀请码,type为`register`时生效																																	|
| myInviteCode|String	| 否	|设置当前注册用户自己的邀请码,type为`register`时生效																										|
雪洛's avatar
雪洛 已提交
630 631 632

**响应参数**

雪洛's avatar
雪洛 已提交
633 634 635 636 637 638
| 字段				| 类型	| 必填| 说明																		|
| ---					| ---		| ---	| ---																			|
| code				| Number| 是	|错误码,0表示成功												|
| msg					| String| 是	|详细信息																	|
| uid					| String| 是	|用户uid																	|
| type				| String| 是	|操作类型,`login`为登录、`register`为注册|
雪洛's avatar
雪洛 已提交
639
| userInfo		| Object| 是	|用户全部信息								|
雪洛's avatar
雪洛 已提交
640 641
| token				| String| -		|登录成功之后返回的token信息							|
| tokenExpired| String| -		|token过期时间														|
雪洛's avatar
雪洛 已提交
642 643 644 645 646 647 648 649

**示例代码**

```js
// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
雪洛's avatar
雪洛 已提交
650
		mobile,
雪洛's avatar
雪洛 已提交
651 652 653
    code
	} = event
	const res = await uniID.loginBySms({
雪洛's avatar
雪洛 已提交
654
		mobile,
雪洛's avatar
雪洛 已提交
655 656 657 658 659
    code
	})
	return res
}

雪洛's avatar
雪洛 已提交
660
```
W
wanganxp 已提交
661 662 663 664 665 666 667

## 绑定手机号

用法:`uniID.bindMobile(Object mobileInfo)`

**mobileInfo**参数说明

雪洛's avatar
雪洛 已提交
668 669 670 671 672
| 字段	| 类型	| 必填| 说明																																			|
| ---		| ---		| ---	| ---																																				|
| uid		| String| 是	|用户Id,可以通过checkToken返回																							|
| mobile| String| 是	|用户手机号																																	|
| code	| String| 否	|验证码,为兼容旧版逻辑此参数不填写时不会进行验证码校验,而是直接绑定手机号	|
W
wanganxp 已提交
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| String| 是	|详细信息					|

**示例代码**

```js
// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
雪洛's avatar
雪洛 已提交
688
		mobile,
雪洛's avatar
雪洛 已提交
689
    code
雪洛's avatar
雪洛 已提交
690 691 692 693
	} = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
雪洛's avatar
雪洛 已提交
694
  }
雪洛's avatar
雪洛 已提交
695
	const res = await uniID.bindMobile({
雪洛's avatar
雪洛 已提交
696
    uid: payload.uid,
雪洛's avatar
雪洛 已提交
697
		mobile,
雪洛's avatar
雪洛 已提交
698 699 700 701 702
    code
	})
	return res
}

雪洛's avatar
雪洛 已提交
703 704 705
```

## 解绑手机
雪洛's avatar
雪洛 已提交
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730

用法:`uniID.unbindMobile(Object mobileInfo)`

**mobileInfo**参数说明

| 字段	| 类型	| 必填| 说明																																			|
| ---		| ---		| ---	| ---																																				|
| uid		| String| 是	|用户Id,可以通过checkToken返回																							|
| mobile| String| 是	|用户手机号																																	|
| code	| String| 否	|验证码,此参数不填写时不会进行验证码校验,而是直接绑定手机号	|

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| String| 是	|详细信息					|

**示例代码**

```js
// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
雪洛's avatar
雪洛 已提交
731
		mobile,
雪洛's avatar
雪洛 已提交
732
    code
雪洛's avatar
雪洛 已提交
733 734 735 736
	} = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
雪洛's avatar
雪洛 已提交
737
  }
雪洛's avatar
雪洛 已提交
738
	const res = await uniID.unbindMobile({
雪洛's avatar
雪洛 已提交
739
    uid: payload.uid,
雪洛's avatar
雪洛 已提交
740
		mobile,
雪洛's avatar
雪洛 已提交
741
    code
W
wanganxp 已提交
742 743 744 745 746
	})
	return res
}

```
雪洛's avatar
雪洛 已提交
747 748 749 750

## 邮箱验证码直接登录

用法:`uniID.loginByEmail(Object emailInfo)`
雪洛's avatar
雪洛 已提交
751 752 753

**mobileInfo**参数说明

雪洛's avatar
雪洛 已提交
754 755 756 757 758 759 760
| 字段					| 类型	| 必填| 说明																																					|
| ---						| ---		| ---	| ---																																						|
| email					| String| 是	|用户邮箱																																				|
| code					| String| 是	|验证码																																					|
| type					| String| 否	|指定操作类型,覆盖存在则登录不存在则注册的默认行为,可选值为`login``register`|
| password			|String	| 否	|密码,type为`register`时生效																										|
| myInviteCode	|String	| 否	|设置当前注册用户自己的邀请码,type为`register`时生效														|
雪洛's avatar
雪洛 已提交
761 762 763 764 765 766 767

**响应参数**

| 字段				| 类型	| 必填| 说明											|
| ---					| ---		| ---	| ---												|
| code				| Number| 是	|错误码,0表示成功					|
| msg					| String| 是	|详细信息										|
雪洛's avatar
雪洛 已提交
768
| uid					| String| 是	|用户uid																	|
雪洛's avatar
雪洛 已提交
769
| userInfo		| Object| 是	|用户全部信息								|
雪洛's avatar
雪洛 已提交
770
| type				| String| 是	|操作类型,`login`为登录、`register`为注册|
雪洛's avatar
雪洛 已提交
771 772 773 774 775 776 777 778 779 780
| token				| String| -		|登录成功之后返回的token信息|
| tokenExpired| String| -		|token过期时间							|

**示例代码**

```js
// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
雪洛's avatar
雪洛 已提交
781
		email,
雪洛's avatar
雪洛 已提交
782 783 784
    code
	} = event
	const res = await uniID.loginByEmail({
雪洛's avatar
雪洛 已提交
785
		email,
雪洛's avatar
雪洛 已提交
786 787 788 789 790
    code
	})
	return res
}

雪洛's avatar
雪洛 已提交
791
```
W
wanganxp 已提交
792 793 794 795 796 797 798

## 绑定邮箱

用法:`uniID.bindEmail(Object emailInfo)`

**emailInfo**参数说明

雪洛's avatar
雪洛 已提交
799 800 801 802 803
| 字段	| 类型	| 必填| 说明																									|
| ---		| ---		| ---	| ---																										|
| uid		| String| 是	|用户Id,可以通过checkToken返回													|
| email	| String| 是	|用户邮箱																								|
| code	| String| 否	|用户邮箱验证码,不填此字段或留空时直接绑定不校验验证码	|
W
wanganxp 已提交
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| String| 是	|详细信息					|

**示例代码**

```js
// 云函数bind-email代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
雪洛's avatar
雪洛 已提交
819
		email,
雪洛's avatar
雪洛 已提交
820
    code
雪洛's avatar
雪洛 已提交
821 822 823 824
	} = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
雪洛's avatar
雪洛 已提交
825
  }
雪洛's avatar
雪洛 已提交
826
	const res = await uniID.bindEmail({
雪洛's avatar
雪洛 已提交
827
    uid: payload.uid,
雪洛's avatar
雪洛 已提交
828
		email,
雪洛's avatar
雪洛 已提交
829
    code
W
wanganxp 已提交
830 831 832 833 834
	})
	return res
}


雪洛's avatar
雪洛 已提交
835
```
雪洛's avatar
雪洛 已提交
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862

## 解绑邮箱

用法:`uniID.unbindEmail(Object emailInfo)`

**emailInfo**参数说明

| 字段	| 类型	| 必填| 说明																									|
| ---		| ---		| ---	| ---																										|
| uid		| String| 是	|用户Id,可以通过checkToken返回													|
| email	| String| 是	|用户邮箱																								|
| code	| String| 否	|用户邮箱验证码,不填此字段或留空时直接绑定不校验验证码	|

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| String| 是	|详细信息					|

**示例代码**

```js
// 云函数bind-email代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
雪洛's avatar
雪洛 已提交
863
		email,
雪洛's avatar
雪洛 已提交
864
    code
雪洛's avatar
雪洛 已提交
865 866 867 868
	} = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
雪洛's avatar
雪洛 已提交
869
  }
雪洛's avatar
雪洛 已提交
870
	const res = await uniID.unbindEmail({
雪洛's avatar
雪洛 已提交
871
    uid: payload.uid,
雪洛's avatar
雪洛 已提交
872
		email,
雪洛's avatar
雪洛 已提交
873 874 875 876
    code
	})
	return res
}
W
wanganxp 已提交
877 878 879 880
```

## 登出

雪洛's avatar
雪洛 已提交
881
用法:`uniID.logout(String token);`
W
wanganxp 已提交
882 883 884 885 886

**注意**

- 登出成功之后应删除持久化存储的token,键值为:uniIdToken,`uni.removeStorageSync('uniIdToken')`

雪洛's avatar
雪洛 已提交
887
**参数说明**
W
wanganxp 已提交
888 889 890

| 字段| 类型	| 必填| 说明	|
| ---	| ---		| ---	| ---		|
雪洛's avatar
雪洛 已提交
891
| token	| String| 是	|用户token|
W
wanganxp 已提交
892 893 894 895 896 897 898 899 900 901 902 903 904 905

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| String| 是	|详细信息					|

**示例代码**

```js
// 云函数logout代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
雪洛's avatar
雪洛 已提交
906
	const res = await uniID.logout(uniIdToken)
W
wanganxp 已提交
907 908 909
	return res
}

雪洛's avatar
雪洛 已提交
910
```
雪洛's avatar
雪洛 已提交
911 912 913

## 微信登录

雪洛's avatar
雪洛 已提交
914
用法:`uniID.loginByWeixin(Object loginByWexinParams);`
雪洛's avatar
雪洛 已提交
915 916

**注意**
雪洛's avatar
雪洛 已提交
917 918

- 需要在config.json内使用微信登录的平台下配置appid和appsecret
雪洛's avatar
雪洛 已提交
919
- uniId会自动判断客户端平台
雪洛's avatar
雪洛 已提交
920
- 登录成功之后应持久化存储token,键值为:uniIdToken,`uni.setStorageSync('uniIdToken', res.result.token)`
雪洛's avatar
雪洛 已提交
921 922 923 924
- App端获取code不可直接调用`uni.login`,详细用法可以看下面示例

**参数说明**

雪洛's avatar
雪洛 已提交
925 926 927 928 929
| 字段				| 类型	| 必填| 说明																																																														|
| ---					| ---		| ---	| ---																																																															|
| code				| String| 是	|微信登录返回的code																																																								|
| platform		|String	| 否	|客户端类型:`mp-weixin``app-plus`,默认uni-id会自动取客户端类型,但是在云函数url化等场景无法取到客户端类型,可以使用此参数指定	|
| myInviteCode|String	| 否	|设置当前注册用户自己的邀请码,type为`register`时生效																																							|
雪洛's avatar
雪洛 已提交
930 931 932

**响应参数**

雪洛's avatar
雪洛 已提交
933 934 935 936 937 938 939 940 941
| 字段						| 类型		| 必填| 说明																		|
| ---							| ---			| ---	| ---																			|
| code						| Number	| 是	|错误码,0表示成功												|
| msg							| String	| 是	|详细信息																	|
| uid							| String	| 是	|用户uid																	|
| type						| String	| 是	|操作类型,`login`为登录、`register`为注册|
| openid					| String	| 是	|用户openid																|
| unionid					| String	| 否	|用户unionid,能取到此参数时会返回				|
| token						| String	| 是	|登录成功之后返回的token信息							|
雪洛's avatar
雪洛 已提交
942
| userInfo		| Object| 是	|用户全部信息								|
雪洛's avatar
雪洛 已提交
943 944 945
| tokenExpired		| String	| 是	|token过期时间														|
| mobileConfirmed	| Boolean	| 是	|是否已验证手机号													|
| emailConfirmed	| Boolean	| 是	|是否已验证邮箱														|
雪洛's avatar
雪洛 已提交
946 947 948 949 950 951

**示例代码**

```js
// 云函数login-by-weixin代码
const uniID = require('uni-id')
雪洛's avatar
雪洛 已提交
952 953 954 955 956 957
exports.main = async function(event,context) {
  // 如下旧写法依然支持
	// const res = await uniID.loginByWeixin(event.code)
	const res = await uniID.loginByWeixin({
    code: event.code
  })
雪洛's avatar
雪洛 已提交
958 959
	return res
}
雪洛's avatar
雪洛 已提交
960 961 962

// 客户端代码
// 代码较长建议直接参考插件市场示例项目:https://ext.dcloud.net.cn/plugin?id=2116
雪洛's avatar
雪洛 已提交
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
let weixinAuthService
export default {
  data() {
    return {
      hasWeixinAuth: false
    }
  },
  onLoad() {
    // #ifdef APP-PLUS
    plus.oauth.getServices((services) => {
      weixinAuthService = services.find((service) => {
        return service.id === 'weixin'
      })
      if (weixinAuthService) {
        this.hasWeixinAuth = true
      }
    });
    // #endif
  },
  methods: {
    getWeixinCode() {
      return new Promise((resolve, reject) => {
        // #ifdef MP-WEIXIN
        uni.login({
          provider: 'weixin',
          success(res) {
            resolve(res.code)
          },
          fail(err) {
            reject(new Error('微信登录失败'))
          }
        })
        // #endif
        // #ifdef APP-PLUS
        weixinAuthService.authorize(function(res) {
          resolve(res.code)
        }, function(err) {
          console.log(err)
          reject(new Error('微信登录失败'))
        });
        // #endif
      })
    },
    loginByWeixin() {
      this.getWeixinCode().then((code) => {
        return uniCloud.callFunction({
          name: 'login-by-weixin',
          data: {
            code
          }
        })
      }).then((res) => {
        uni.showModal({
          showCancel: false,
          content: JSON.stringify(e.result)
        })
        if (res.result.code === 0) {
          uni.setStorageSync('uniIdToken', e.result.token)
        }
      }).catch(() => {
        uni.showModal({
          showCancel: false,
          content: '微信登录失败,请稍后再试'
        })
      })
    }
  }
雪洛's avatar
雪洛 已提交
1030 1031 1032 1033
}

```

雪洛's avatar
雪洛 已提交
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
## 获取微信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
}
```

雪洛's avatar
雪洛 已提交
1069
## 绑定微信
雪洛's avatar
雪洛 已提交
1070 1071

用法:`uniID.bindWeixin(Object weixinInfo);`
雪洛's avatar
雪洛 已提交
1072 1073 1074

**weixinInfo 参数说明**

雪洛's avatar
雪洛 已提交
1075 1076
**参数说明**

雪洛's avatar
雪洛 已提交
1077 1078 1079 1080 1081
| 字段		| 类型	| 必填| 说明																																																														|
| ---			| ---		| ---	| ---																																																															|
| uid			| String| 是	|用户Id,可以通过checkToken返回																																																		|
| code		| String| 是	|微信登录返回的code																																																								|
|platform	|String	|否		|客户端类型:`mp-weixin``app-plus`,默认uni-id会自动取客户端类型,但是在云函数url化等场景无法取到客户端类型,可以使用此参数指定	|
雪洛's avatar
雪洛 已提交
1082 1083 1084 1085 1086 1087

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
雪洛's avatar
雪洛 已提交
1088 1089
| msg	| String| 是	|详细信息					|

雪洛's avatar
雪洛 已提交
1090
```js
雪洛's avatar
雪洛 已提交
1091
// 云函数代码
雪洛's avatar
雪洛 已提交
1092
const uniID = require('uni-id')
雪洛's avatar
雪洛 已提交
1093 1094 1095 1096
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
  	return payload
雪洛's avatar
雪洛 已提交
1097
  }
雪洛's avatar
雪洛 已提交
1098 1099 1100
	const res = await uniID.bindWeixin({
    uid: payload.uid,
    code: event.code
雪洛's avatar
雪洛 已提交
1101 1102
  })
	return res
雪洛's avatar
雪洛 已提交
1103 1104 1105 1106 1107
}
```

## 解绑微信

雪洛's avatar
雪洛 已提交
1108
用法:`uniID.unbindWeixin(String uid);`
雪洛's avatar
雪洛 已提交
1109

雪洛's avatar
雪洛 已提交
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
**参数说明**

| 字段| 类型	| 必填| 说明													|
| ---	| ---		| ---	| ---														|
| uid	| String| 是	|用户Id,可以通过checkToken返回	|

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
雪洛's avatar
雪洛 已提交
1121 1122
| msg	| String| 是	|详细信息					|

雪洛's avatar
雪洛 已提交
1123
```js
雪洛's avatar
雪洛 已提交
1124
// 云函数代码
雪洛's avatar
雪洛 已提交
1125
const uniID = require('uni-id')
雪洛's avatar
雪洛 已提交
1126 1127 1128 1129
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
  	return payload
雪洛's avatar
雪洛 已提交
1130 1131 1132
  }
	const res = await uniID.unbindWeixin(payload.uid)
	return res
雪洛's avatar
雪洛 已提交
1133 1134
}
```
雪洛's avatar
雪洛 已提交
1135 1136 1137

## 支付宝登录

雪洛's avatar
雪洛 已提交
1138
用法:`uniID.loginByAlipay(Object loginByAlipayParams);`
雪洛's avatar
雪洛 已提交
1139 1140

**注意**
雪洛's avatar
雪洛 已提交
1141

雪洛's avatar
雪洛 已提交
1142
- 需要在config.json内支付宝平台下配置appid和privateKey(应用私钥)
雪洛's avatar
雪洛 已提交
1143
- 登录成功之后应持久化存储token,键值为:uniIdToken,`uni.setStorageSync('uniIdToken', res.result.token)`
雪洛's avatar
雪洛 已提交
1144 1145 1146

**参数说明**

雪洛's avatar
雪洛 已提交
1147 1148 1149 1150 1151
| 字段				| 类型	| 必填| 说明																																																														|
| ---					| ---		| ---	| ---																																																															|
| code				| String| 是	|支付宝登录返回的code																																																							|
| platform		| String| 否	|客户端类型:`mp-weixin``app-plus`,默认uni-id会自动取客户端类型,但是在云函数url化等场景无法取到客户端类型,可以使用此参数指定	|
| myInviteCode| String| 否	|设置当前注册用户自己的邀请码,type为`register`时生效																																							|
雪洛's avatar
雪洛 已提交
1152 1153 1154

**响应参数**

雪洛's avatar
雪洛 已提交
1155 1156 1157 1158 1159 1160 1161 1162
| 字段						| 类型		| 必填| 说明																		|
| ---							| ---			| ---	| ---																			|
| code						| Number	| 是	|错误码,0表示成功												|
| msg							| String	| 是	|详细信息																	|
| uid							| String	| 是	|用户uid																	|
| type						| String	| 是	|操作类型,`login`为登录、`register`为注册|
| openid					| String	| 是	|用户openid																|
| token						| String	| 是	|登录成功之后返回的token信息							|
雪洛's avatar
雪洛 已提交
1163
| userInfo		| Object| 是	|用户全部信息								|
雪洛's avatar
雪洛 已提交
1164 1165 1166
| tokenExpired		| String	| 是	|token过期时间														|
| mobileConfirmed	| Boolean	| 是	|是否已验证手机号													|
| emailConfirmed	| Boolean	| 是	|是否已验证邮箱														|
雪洛's avatar
雪洛 已提交
1167 1168 1169 1170 1171 1172

**示例代码**

```js
// 云函数代码
const uniID = require('uni-id')
雪洛's avatar
雪洛 已提交
1173 1174 1175 1176 1177 1178
exports.main = async function(event,context) {
  // 如下旧写法依然支持
	// const res = await uniID.loginByAlipay(event.code)
	const res = await uniID.loginByAlipay({
    code: event.code
  })
雪洛's avatar
雪洛 已提交
1179 1180
	return res
}
雪洛's avatar
雪洛 已提交
1181
```
雪洛's avatar
雪洛 已提交
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216


## 获取微信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
}
```
雪洛's avatar
雪洛 已提交
1217 1218 1219

## 绑定支付宝

雪洛's avatar
雪洛 已提交
1220
用法:`uniID.bindAlipay(Object alipayInfo);`
雪洛's avatar
雪洛 已提交
1221 1222 1223

**alipayInfo 参数说明**

雪洛's avatar
雪洛 已提交
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
**参数说明**

| 字段| 类型	| 必填| 说明													|
| ---	| ---		| ---	| ---														|
| uid	| String| 是	|用户Id,可以通过checkToken返回	|
| code| String| 是	|支付宝登录返回的code							|

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
雪洛's avatar
雪洛 已提交
1236 1237
| msg	| String| 是	|详细信息					|

雪洛's avatar
雪洛 已提交
1238 1239 1240
```js
// 云函数代码
const uniID = require('uni-id')
雪洛's avatar
雪洛 已提交
1241 1242 1243 1244
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
  	return payload
雪洛's avatar
雪洛 已提交
1245
  }
雪洛's avatar
雪洛 已提交
1246 1247 1248
	const res = await uniID.bindAlipay({
    uid: payload.uid,
    code: event.code
雪洛's avatar
雪洛 已提交
1249 1250
  })
	return res
雪洛's avatar
雪洛 已提交
1251 1252 1253 1254 1255
}
```

## 解绑支付宝

雪洛's avatar
雪洛 已提交
1256
用法:`uniID.unbindAlipay(String uid);`
雪洛's avatar
雪洛 已提交
1257

雪洛's avatar
雪洛 已提交
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
**参数说明**

| 字段| 类型	| 必填| 说明													|
| ---	| ---		| ---	| ---														|
| uid	| String| 是	|用户Id,可以通过checkToken返回	|

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
雪洛's avatar
雪洛 已提交
1269 1270
| msg	| String| 是	|详细信息					|

雪洛's avatar
雪洛 已提交
1271 1272 1273
```js
// 云函数代码
const uniID = require('uni-id')
雪洛's avatar
雪洛 已提交
1274 1275 1276 1277
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
  	return payload
雪洛's avatar
雪洛 已提交
1278 1279 1280
  }
	const res = await uniID.unbindAlipay(payload.uid)
	return res
雪洛's avatar
雪洛 已提交
1281 1282 1283 1284 1285
}
```

## 更新用户信息

1286
用法:`uniID.updateUser(Object userInfo);`
雪洛's avatar
雪洛 已提交
1287 1288 1289

此接口用于在其他接口不满足需求时使用

1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
**userInfo参数说明**

| 字段| 类型	| 必填| 说明													|
| ---	| ---		| ---	| ---														|
| uid	| String| 是	|用户Id,可以通过checkToken返回	|
| 其余参数	| Any| 是	|要设置的用户信息	|

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
雪洛's avatar
雪洛 已提交
1302 1303
| msg	| String| 是	|详细信息					|

1304 1305 1306
```js
// 云函数代码
const uniID = require('uni-id')
雪洛's avatar
雪洛 已提交
1307 1308 1309 1310
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
  	return payload
1311
  }
雪洛's avatar
雪洛 已提交
1312 1313 1314
	const res = await uniID.updateUser({
    uid: payload.uid,
    nickname: 'user nickname'
1315 1316
  })
	return res
雪洛's avatar
雪洛 已提交
1317 1318
}
```
雪洛's avatar
雪洛 已提交
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448

## 获取用户信息

用法:`uniID.getUserInfo(Object GetUserInfoParams);`

此接口用于在其他接口不满足需求时使用

**参数说明**

| 字段	| 类型	| 必填| 说明													|
| ---		| ---		| ---	| ---														|
| uid		| String| 是	|用户Id,可以通过checkToken返回	|
| field	| Array	| 否	|指定返回的字段,不传则返回所有	|

**响应参数**

| 字段		| 类型	| 必填| 说明						|
| ---			| ---		| ---	| ---							|
| code		| Number| 是	|错误码,0表示成功|
| msg			| String| 是	|详细信息					|
|userInfo	|Object	| 是	|获取的用户信息		|

```js
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
  	return payload
  }
	const res = await uniID.getUserInfo({
    uid: payload.uid,
    field: ['mobile']
  })
	return res
}
```

## 设置用户邀请码

针对未生成邀请码的用户使用此方法生成邀请码

用法:`uniID.setUserInviteCode(Object SetUserInviteCodeParams);`

此接口用于在其他接口不满足需求时使用

**参数说明**

| 字段				| 类型	| 必填| 说明																																								|
| ---					| ---		| ---	| ---																																									|
| uid					| String| 是	|用户Id																																								|
| myInviteCode| String| 否	|自行指定邀请码(不可与其他账号邀请码重复),如果不传此字段则自动生成不重复的6位邀请码|

**响应参数**

| 字段				  | 类型	  | 必填 | 说明						|
| ---					| ---		| ---	| ---							|
| code				| Number| 是	  |错误码,0表示成功|
| msg					| String| 是	  |详细信息					|
| myInviteCode| String| 是	  |最终设置的邀请码	|

## 用户接受邀请

此接口用于在注册之后再填写邀请码的场景,多数情况下不会用到此接口而是在注册时填写邀请码

用法:`uniID.acceptInvite(Object AcceptInviteParams);`

**参数说明**

| 字段			| 类型	| 必填| 说明					|
| ---				| ---		| ---	| ---						|
| uid				| String| 是	|用户Id					|
| inviteCode| String| 是	|邀请人的邀请码	|

**响应参数**

| 字段				  | 类型	  | 必填 | 说明						|
| ---					| ---		| ---	| ---							|
| code				| Number| 是	  |错误码,0表示成功|
| msg					| String| 是	  |详细信息					|

## 获取接受邀请的用户清单

用法:`uniID.getInvitedUser(Object GetInvitedUserParams);`

此接口用于在其他接口不满足需求时使用

**参数说明**

| 字段			| 类型		| 必填| 说明												|
| ---				| ---			| ---	| ---													|
| uid				| String	| 是	|用户Id												|
| level			| Number	| 否	|指定获取第几级邀请用户,默认1|
| limit			| Number	| 否	|指定返回列表长度,默认20			|
| offset		| Number	| 否	|指定列表偏移量,默认0				|
| needTotal	| Boolean	| 否	|是否需要返回总数,默认false	|

**响应参数**

| 字段				| 类型	| 必填| 说明						|
| ---					| ---		| ---	| ---							|
| code				| Number| 是	|错误码,0表示成功|
| msg					| String| 是	|详细信息					|
| invitedUser	| Array	| 是	|邀请的用户列表		|

**invitedUser每项结构**

| 字段				| 类型	| 必填| 说明															|
| ---					| ---		| ---	| ---																|
| username		|String	|-		|被邀请者用户名											|
| mobile			|String	|-		|被邀请者手机号											|
| invite_time	|String	|-		|被邀请者注册时间,以时间戳形式返回	|

```js
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
  	return payload
  }
	const res = await uniID.getUserInfo({
    uid: payload.uid,
    limit: 10,
    offset: 0,
    needTotal: true
  })
	return res
}
```
雪洛's avatar
雪洛 已提交
1449

雪洛's avatar
雪洛 已提交
1450
## 自行初始化uni-id@init
雪洛's avatar
雪洛 已提交
1451

雪洛's avatar
雪洛 已提交
1452
用法:`uniID.init(Object config);`
雪洛's avatar
雪洛 已提交
1453 1454 1455

此接口适用于不希望使用config.json初始化而是希望通过js的方式传入配置的情况

雪洛's avatar
雪洛 已提交
1456
**config参数说明**
雪洛's avatar
雪洛 已提交
1457

雪洛's avatar
雪洛 已提交
1458 1459
config格式与config.json完全相同

雪洛's avatar
雪洛 已提交
1460 1461 1462
**响应参数**


雪洛's avatar
雪洛 已提交
1463 1464 1465

```js
// 云函数代码
雪洛's avatar
雪洛 已提交
1466 1467 1468 1469 1470 1471 1472 1473 1474
const uniID = require('uni-id')
uniID.init({
	"passwordSecret": "passwordSecret-demo", // 用于加密用户密码
	"tokenSecret": "tokenSecret-demo", // 用于生成token
	"tokenExpiresIn": 7200, // token过期时间
	"passwordErrorLimit": 6, // 同一个ip密码错误最大重试次数
	"passwordErrorRetryTime": 3600, // 超过密码重试次数之后的等待时间
	"service": {
		"sms": {
雪洛's avatar
雪洛 已提交
1475
			"name": "your app name", // 应用名称对应uniCloud.sendSms的data参数内的name
雪洛's avatar
雪洛 已提交
1476 1477 1478 1479 1480
			"codeExpiresIn": 180, // 验证码过期时间,单位:秒,只可取60的整数倍,不填此参数时会取默认值180秒
			"smsKey": "your sms key", // 短信密钥key
			"smsSecret": "your sms secret" // 短信密钥secret
		}
	}
雪洛's avatar
雪洛 已提交
1481
})
雪洛's avatar
雪洛 已提交
1482 1483 1484 1485
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
  	return payload
雪洛's avatar
雪洛 已提交
1486
  }
雪洛's avatar
雪洛 已提交
1487 1488 1489
	const res = await uniID.updateUser({
    uid: payload.uid,
    nickname: 'user nickname'
雪洛's avatar
雪洛 已提交
1490 1491
  })
	return res
雪洛's avatar
雪洛 已提交
1492 1493
}
```
雪洛's avatar
雪洛 已提交
1494 1495 1496 1497 1498 1499 1500 1501 1502

# 裂变@fission

`1.1.2`版本起uni-id支持裂变功能,目前仅适用手机号+验证码方式注册可以填写邀请码(inviteCode)接受邀请。

`config.json`内配置了`autoSetInviteCode: true`则在用户注册时会自动给设置不重复的6位邀请码,如果不希望使用自动设置的邀请码可以自行传入`myInviteCode`参数来设置邀请码,需要注意的是要保证邀请码唯一。

`config.json`内配置了`forceInviteCode: true`则只有使用邀请码才可以注册(仅手机号+验证码注册方式支持)。

雪洛's avatar
雪洛 已提交
1503
针对之前使用了旧版本(不支持裂变)的uni-id,现在想增加裂变功能,可以调用`setUserInviteCode`接口给已注册用户设置邀请码,在设置之前可以使用`my_invite_code不存在`作为条件查询所有需要设置的用户。
雪洛's avatar
雪洛 已提交
1504 1505 1506 1507 1508

如果希望用户注册完成之后再填写邀请人的邀请码,可以调用`acceptInvite`接口来使用户接受邀请。

`getInvitedUser`接口可以用于获取接受邀请的用户列表,其中level参数可以用来设置要获取哪一级的邀请用户,不填写level参数则默认获取第一级。

雪洛's avatar
雪洛 已提交
1509 1510 1511 1512
如果想详细的体验一下裂变流程,可以在插件市场导入[前后一体登录模板](https://ext.dcloud.net.cn/plugin?id=13),此项目内已有邀请用户注册示例,流程如下

**分享邀请码/邀请链接**

雪洛's avatar
雪洛 已提交
1513 1514
<img width="375" src="https://vkceyugu.cdn.bspapp.com/VKCEYUGU-dc-site/1b181d40-e377-11ea-b680-7980c8a877b8.jpeg" />

雪洛's avatar
雪洛 已提交
1515 1516 1517

**受邀者注册**

雪洛's avatar
雪洛 已提交
1518
<img width="375" src="https://vkceyugu.cdn.bspapp.com/VKCEYUGU-dc-site/1b12c610-e377-11ea-b997-9918a5dda011.jpeg" />
W
wanganxp 已提交
1519 1520 1521 1522 1523 1524 1525

# 数据库结构

## 用户表

表名:uni-id-users

雪洛's avatar
雪洛 已提交
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550
| 字段						| 类型			| 必填| 描述																											|
| ----------------| ---------	| ----| -------------------------------------------								|
| \_id						| Object ID	| 是	| 存储文档 ID(用户 ID),系统自动生成											|
| username				| String		| 是	| 用户名,不允许重复																				|
| password				| String		| 否	| 密码,加密存储																						|
| nickname				| String		| 否	| 用户昵称																									|
| gender					| Integer		| 否	| 用户性别:0 未知 1 男性 2 女性														|
| status					| Integer		| 是	| 用户状态:0 正常 1 禁用 2 审核中 3 审核拒绝								|
| mobile					| String		| 否	| 手机号码																									|
| mobile_confirmed| Integer		| 否	| 手机号验证状态:0 未验证 1 已验证													|
| email						| String		| 否	| 邮箱地址																									|
| email_confirmed	| Integer		| 否	| 邮箱验证状态:0 未验证 1 已验证														|
| avatar					| String		| 否	| 头像地址																									|
| wx_unionid			| String		| 否	| 微信unionid																								|
| wx_openid				| Object		| 否	| 微信各个平台openid																				|
| ali_openid			| String		| 否	| 支付宝平台openid																					|
| comment					| String		| 否	| 备注																											|
| realname_auth		| Object		| 否	| 实名认证信息																							|
| register_date		| Timestamp	| 否	| 注册时间																									|
| register_ip			| String		| 否	| 注册时 IP 地址																						|
| last_login_date	| Timestamp	| 否	| 最后登录时间																							|
| last_login_ip		| String		| 否	| 最后登录时 IP 地址																				|
| login_ip_limit	| Array			| 否	| 登录 IP 限制																							|
| inviter_uid			| Array			| 否	| 邀请人uid,按层级从下往上排列的uid数组,即第一个是直接上级|
| my_invite_code	| String		| 否	| 用户自己的邀请码																					|
雪洛's avatar
雪洛 已提交
1551 1552 1553 1554 1555 1556 1557

**wx_openid字段定义**

| 字段    | 类型   | 必填 | 描述     |
| ------- | ------ | ---- | -------- |
| app-plus | String | 否   | app平台微信openid |
| mp-weixin| String | 否   | 微信小程序平台openid  |
W
wanganxp 已提交
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601

**realNameAuth 扩展字段定义**
该字段存储实名认证信息。

| 字段            | 类型      | 必填 | 描述                                                |
| --------------- | --------- | ---- | --------------------------------------------------- |
| type            | Integer   | 是   | 用户类型:0 个人用户 1 企业用户                     |
| auth_status     | Integer   | 是   | 认证状态:0 未认证 1 等待认证 2 认证通过 3 认证失败 |
| auth_date       | Timestamp | 否   | 认证通过时间                                        |
| real_name       | String    | 否   | 真实姓名/企业名称                                   |
| identity        | String    | 否   | 身份证号码/营业执照号码                             |
| id_card_front   | String    | 否   | 身份证正面照 URL                                    |
| id_card_back    | String    | 否   | 身份证反面照 URL                                    |
| id_card_in_hand | String    | 否   | 手持身份证照片 URL                                  |
| license         | String    | 否   | 营业执照 URL                                        |
| contact_person  | String    | 否   | 联系人姓名                                          |
| contact_mobile  | String    | 否   | 联系人手机号码                                      |
| contact_email   | String    | 否   | 联系人邮箱                                          |

**job 扩展字段定义**

| 字段    | 类型   | 必填 | 描述     |
| ------- | ------ | ---- | -------- |
| company | String | 否   | 公司名称 |
| title   | String | 否   | 职位     |

用户集合示例:

```
{
  "_id": "f2a60d815ee1da3900823d45541bb162",
  "username": "姓名"
  "password": "503005d4dd16dd7771b2d0a47aaef927e9dba89e",
  "status":0,//用户状态:0正常 1禁用 2审核中 3审核拒绝
  "mobile":"",
  "mobile_confirmed":0, //手机号是否验证,0为未验证,1为已验证
  "email":"amdin@domain.com",
  "email_confirmed":0, //邮箱是否验证,0为未验证,1为已验证
  "avatar":"https://cdn.domain.com/avatar.png"
  "register_ip": "123.120.11.128", //注册IP
  "last_login_ip": "123.120.11.128", //最后登录IP

}
```
雪洛's avatar
雪洛 已提交
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622

## 验证码表

表名:`uni-verify`

| 字段       | 类型      | 必填 | 描述                                   |
| ---------- | --------- | ---- | -------------------------------------- |
| \_id       | Object ID | 是   | 存储文档 ID(验证码 ID),系统自动生成 |
| mobile     | String    | 是   | 手机号,和邮箱二选一                 |
| email      | String    | 是   | 邮箱,和手机号二选一                  |
| code       | String    | 是   | 验证码                                 |
| type       | String   | 是   | 验证类型:login, bind, unbind, pay     |
| state      | Integer   | 是   | 验证状态:0 未验证 1 已验证 2 已作废    |
| ip         | String    | 是   | 请求时 IP 地址                         |
| created_at | Timestamp | 是   | 创建时间                               |
| expired_at | Timestamp | 是   | 验证码过期时间                         |

# 错误码

`1.1.0`版本使用此错误码规范

雪洛's avatar
雪洛 已提交
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
|模块						|模块码	|错误代码	|错误信息								|
|:-:						|:-:	|:-:		|:-:									|
|登录通用模块				|100	|01			|账号已禁用								|
|账号、邮箱、手机+密码登录	|101	|01			|用户不存在								|
|							|		|02			|密码错误								|
|							|		|03			|密码错误次数过多						|
|手机号验证码登录/注册		|102	|01			|手机号已存在(传入type='register'且手机号已注册时触发)|
|               		|102	|02			|此手机号尚未注册(传入type='login'且手机号未注册时触发)		|
|               		|102	|03			|邀请码无效(邀请码存在且唯一时才算有效)		|  
|邮箱验证码登录/注册		|103	|01			|此邮箱已注册(传入type='register'且邮箱已注册时触发)|
|               		|103	|02			|此邮箱尚未注册(传入type='login'且邮箱未注册时触发)		|
|微信登录/注册				|104	|01			|获取openid失败							|
|支付宝登录/注册			|105	|01			|获取openid失败							|
|注册通用模块				|200	|-			|-										|
|账号、邮箱、手机+密码注册	|201	|01			|用户名、邮箱、手机号必填一项			|
|							|		|02			|用户名、邮箱、手机号冲突				|
|Token类					|300	|-			|-										|
|生成Token					|301	|-			|-										|
|验证Token					|302	|01			|设备特征校验未通过						|
|							|		|02			|云端以不包含此token					|
|							|		|03			|token已过期							|
|							|		|04			|token校验未通过						|
|账号安全类					|400	|-			|-										|
|登出						|401	|-			|-										|
|修改密码					|402	|01			|用户不存在								|
|							|		|02			|旧密码错误								|
|重置密码					|403	|-			|-										|
|验证类						|500	|-			|-										|
|设置验证码					|501	|01			|参数错误								|
|校验验证码					|502	|01			|参数错误								|
|							|		|02			|验证码错误或已失效						|
|发送短信验证码				|503	|01			|验证码发送失败,一般msg内有描述		|
|绑定账号					|600	|-			|-										|
|绑定手机号					|601	|01			|此手机号已被绑定						|
|绑定邮箱					|602	|01			|此邮箱已被绑定							|
|绑定微信					|603	|01			|获取openid失败							|
|							|		|02			|此账号已被绑定							|
|绑定支付宝					|604	|01			|获取openid失败							|
|							|		|02			|此账号已被绑定							|
|解绑账号					|700	|-			|-										|
|解绑手机号					|701	|01			|解绑失败,可能已经解绑或者账号不匹配	|
|解绑邮箱					|702	|01			|解绑失败,可能已经解绑或者账号不匹配	|
|解绑微信					|703	|01			|解绑失败,可能已经解绑					|
|解绑支付宝					|704	|01			|解绑失败,可能已经解绑					|
|基础功能					|800	|-			|-										|
|更新用户信息				|801	|01			|参数错误								|
|设置头像					|802	|-			|-										|
|获取用户信息				|803	|01			|未查询到用户信息	|
|设置用户自己的邀请码			|804	|01			|邀请码设置失败,验证码重复或自动设置重试多次依然重复	|
|       					|	    |02		|邀请码重试多次依然重复	|
|填写邀请人邀请码			|805	|01			|邀请码无效(邀请码存在且唯一时才算有效)	|
|               			|   	|02			|uid错误,用户不存在	|
|               			|   	|03			|邀请码不可修改	|
雪洛's avatar
雪洛 已提交
1676 1677 1678 1679
|获取微信openid			        |806	|01			|未能获取openid	|
|               			|   	|02			|调用获取openid接口失败	|
|获取支付宝openid			        |807	|01			|未能获取openid	|
|               			|   	|02			|调用获取openid接口失败	|
雪洛's avatar
雪洛 已提交
1680 1681 1682 1683 1684 1685 1686 1687
|公用码						|900	|01			|数据库读写异常							|

# FAQ

- token数组为什么越来越长
  + 每次登录成功都会新增一个token,并且检查所有token的有效期删除过期token。正常情况下客户端应该判断持久化存储的token是否还在有效期内,如果还有效就直接进入应用,不再执行登录。这样相当于用户的每个设备上都存在一个有效期内的token,云端也是。

- 复制token到其他环境校验不通过
雪洛's avatar
雪洛 已提交
1688
  + uni-id内会校验客户端ua,如果是在本地调试可以在云函数内修改`context.CLIENTUA`为生成token的设备ua,切记上线删除此逻辑。如果不需要设备和token绑定,可以在config内配置`bindTokenToDevice: false`来关闭绑定
雪洛's avatar
雪洛 已提交
1689 1690

- username、email、mobile三个字段
雪洛's avatar
雪洛 已提交
1691 1692 1693 1694
  + 三个字段均可能为空,但是建议限制一下插入数据库三个字段的格式,比如username不应是邮箱格式或手机号格式,因为登录时可以选择使用username或mobile或email+密码的方式

- 关于邀请码
  + 目前仅手机号+验证码的注册方式支持填写邀请码