uni-id.md 24.9 KB
Newer Older
雪洛's avatar
雪洛 已提交
1 2
# 简介

W
wanganxp 已提交
3 4 5 6 7 8
99%的应用,都要开发用户注册、登录、密码md5加密保存、修改密码、token管理等功能,从前端到后端都需要。

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

`uni-id`应需而生。

W
wanganxp 已提交
9 10 11
`uni-id``uniCloud`开发者提供了统一、简单、可扩展的用户管理能力封装。推荐每个`uniCloud`开发者使用。

`uni-id`可成为开发者应用的用户中心,在插件市场获取更多基于`uni-id`的业务模板,集成到你的应用中。
W
wanganxp 已提交
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

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

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

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

2. 云函数

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

[插件市场](https://ext.dcloud.net.cn/plugin?id=2116)的示例工程中还提供了一个`user-center`的云函数,演示在云函数中如何调用`uni-id`公共模块。

3. 前端调用

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

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

雪洛's avatar
雪洛 已提交
33
对于`uni-id`还未封装的能力,欢迎大家在开源项目上提交 pr,共同完善这个开源项目,[uni-id git仓库](https://gitee.com/dcloud/uni-id.git)
W
wanganxp 已提交
34 35 36 37 38 39 40

# 快速上手

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

1. 准备2.7.14或以上版本的HBuilderX
2. 插件市场导入`uni-id`公用模块,[插件市场 uni-id](https://ext.dcloud.net.cn/plugin?id=2116)
雪洛's avatar
雪洛 已提交
41
3. 修改公用模块`uni-id`下的`config.json`内所需参数(请参考下面config.json的说明)
雪洛's avatar
雪洛 已提交
42
4. 上传`cloudfunctions/common`下的`uni-id`模块
W
wanganxp 已提交
43 44 45
5. 按照[公用模块使用说明](https://uniapp.dcloud.io/uniCloud/cf-common)在云函数下安装`uni-id`模块

或者直接导入[uni-id在插件市场的示例工程](https://ext.dcloud.net.cn/plugin?id=2116)
雪洛's avatar
雪洛 已提交
46 47 48 49 50 51 52 53 54 55 56 57

**config.json的说明**

注意:config.json是一个标准json文件,不支持注释

配置项:

+ `passwordSecret`为用于加密密码入库的密钥
+ `tokenSecret`为生成token需要的密钥
+ `tokenExpiresIn`token有效期,以秒为单位
+ 另外可以按照客户端平台进行不同的配置,参考下面示例

雪洛's avatar
雪洛 已提交
58
```json
雪洛's avatar
雪洛 已提交
59 60 61
{
	"passwordSecret": "passwordSecret-demo",
	"tokenSecret": "tokenSecret-demo",
雪洛's avatar
雪洛 已提交
62
	"tokenExpiresIn": 7200,
雪洛's avatar
雪洛 已提交
63
	"mp-weixin":{
雪洛's avatar
雪洛 已提交
64 65 66 67 68 69
    "oauth":{
      "weixin": {
        "appid": "your mp-weixin appid",
        "appsecret": "your mp-weixin appsecret",
      }
    }
雪洛's avatar
雪洛 已提交
70 71
	},
	"app-plus": {
雪洛's avatar
雪洛 已提交
72 73 74 75 76 77 78
		"tokenExpiresIn": 2592000,
    "oauth":{
      "weixin": {
        "appid": "your app-weixin appid",
        "appsecret": "your app-weixin appsecret",
      }
    }
雪洛's avatar
雪洛 已提交
79 80 81
	}
}
```
W
wanganxp 已提交
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

# API列表

## 用户注册 @register

用法`uniID.register(Object user)`

**注意**

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

**user参数说明**

| 字段		| 类型	| 必填	| 说明			|
| ---		| ---	| ---	| ---			|
| username	| String| 是	|用户名,唯一	|
| password	| String| 是	|密码			|

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

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

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

**响应参数**

| 字段	| 类型	| 必填	| 说明						|
| ---	| ---	| ---	| ---						|
| code	| Number| 是	|错误码,0表示成功			|
| msg	| String| 是	|详细信息					|
| token	| String| -	|注册完成自动登录之后返回的token信息|
113
| tokenExpired	| String| -	|token过期时间|
W
wanganxp 已提交
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

**示例代码**

```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
雪洛 已提交
182
| queryField	| Array| 否	|指定从哪些字段中比对username,不填默认与数据库内的username字段对比, 可取值'username'、'email'、'mobile'|
W
wanganxp 已提交
183 184 185 186 187 188 189 190

**响应参数**

| 字段	| 类型	| 必填	| 说明						|
| ---	| ---	| ---	| ---						|
| code	| Number| 是	|错误码,0表示成功			|
| msg	| String| 是	|详细信息					|
| token	| String| -	|登录成功之后返回的token信息|
191
| tokenExpired	| String| -	|token过期时间|
W
wanganxp 已提交
192 193 194 195 196 197 198 199 200 201 202 203 204 205

**示例代码**

```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
雪洛 已提交
206 207
		password,
    queryField: ['username', 'email', 'mobile']
W
wanganxp 已提交
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
	})
	return res
}
```

## token校验

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

**参数说明**

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

**响应参数**

| 字段| 类型	| 必填| 说明											|
| ---	| ---		| ---	| ---												|
| code| Number| 是	|错误码,0表示成功					|
| msg	| String| 是	|详细信息										|
|uid	| String|否		|用户Id,校验成功之后会返回	|

**注意:**

- 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
雪洛 已提交
252 253 254 255 256 257
| 字段								| 类型	| 必填| 说明													|
| ---									| ---		| ---	| ---														|
| uid									| String| 是	|用户Id,可以通过checkToken返回	|
| oldPassword					| String| 是	|旧密码													|
| newPassword					| String| 是	|新密码													|
| passwordConfirmation| String| 是	|确认新密码											|
W
wanganxp 已提交
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276

**响应参数**

| 字段	| 类型	| 必填	| 说明						|
| ---	| ---	| ---	| ---						|
| 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
雪洛 已提交
277 278 279 280 281 282 283 284 285
	// 校验新密码与确认新密码是否一致
  
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
  
	const res = await uniID.updatePwd({
    uid: payload.uid,
W
wanganxp 已提交
286 287 288 289 290 291 292 293
		oldPassword,
		newPassword,
		passwordConfirmation
	})
	return res
}
```

雪洛's avatar
雪洛 已提交
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
## 重置密码 @reset-password

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

**passwordInfo参数说明**

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

**响应参数**

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

**示例代码**

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

## 加密密码 @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')
	return {
    encResult
  }
}
```

W
wanganxp 已提交
360 361 362 363 364 365
## 设置头像

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

**avatarInfo**参数说明

雪洛's avatar
雪洛 已提交
366 367 368 369
| 字段	| 类型	| 必填| 说明													|
| ---		| ---		| ---	| ---														|
| uid		| String| 是	|用户Id,可以通过checkToken返回	|
| avatar| String| 是	|用户头像URL										|
W
wanganxp 已提交
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

**响应参数**

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

**示例代码**

```js
// 云函数set-avatar代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		avatar
雪洛's avatar
雪洛 已提交
386 387 388 389 390 391 392
	} = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
	const res = await uniID.setAvatar({
    uid: payload.uid,
W
wanganxp 已提交
393 394 395 396 397 398 399 400 401 402 403 404 405
		avatar
	})
	return res
}

```

## 绑定手机号

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

**mobileInfo**参数说明

雪洛's avatar
雪洛 已提交
406 407 408 409
| 字段	| 类型	| 必填| 说明													|
| ---		| ---		| ---	| ---														|
| uid		| String| 是	|用户Id,可以通过checkToken返回	|
| mobile| String| 是	|用户手机号											|
W
wanganxp 已提交
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425

**响应参数**

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

**示例代码**

```js
// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		mobile
雪洛's avatar
雪洛 已提交
426 427 428 429 430 431 432
	} = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
	const res = await uniID.bindMobile({
    uid: payload.uid,
W
wanganxp 已提交
433 434 435 436 437 438 439 440 441 442 443 444 445
		mobile
	})
	return res
}

```

## 绑定邮箱

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

**emailInfo**参数说明

雪洛's avatar
雪洛 已提交
446 447 448 449
| 字段	| 类型	| 必填| 说明													|
| ---		| ---		| ---	| ---														|
| uid		| String| 是	|用户Id,可以通过checkToken返回	|
| email	| String| 是	|用户邮箱												|
W
wanganxp 已提交
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465

**响应参数**

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

**示例代码**

```js
// 云函数bind-email代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const {
		email
雪洛's avatar
雪洛 已提交
466 467 468 469 470 471 472
	} = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
	const res = await uniID.bindEmail({
    uid: payload.uid,
W
wanganxp 已提交
473 474 475 476 477 478 479 480 481 482
		email
	})
	return res
}


```

## 登出

雪洛's avatar
雪洛 已提交
483
用法:`uniID.logout(String token);`
W
wanganxp 已提交
484 485 486 487 488

**注意**

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

雪洛's avatar
雪洛 已提交
489
**参数说明**
W
wanganxp 已提交
490 491 492

| 字段| 类型	| 必填| 说明	|
| ---	| ---		| ---	| ---		|
雪洛's avatar
雪洛 已提交
493
| token	| String| 是	|用户token|
W
wanganxp 已提交
494 495 496 497 498 499 500 501 502 503 504 505 506 507

**响应参数**

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

**示例代码**

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

雪洛's avatar
雪洛 已提交
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
```

## 微信登录

用法:`uniID.loginByWeixin(String code);`

**注意**

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

**参数说明**

| 字段| 类型	| 必填| 说明							|
| ---	| ---		| ---	| ---								|
| code| String| 是	|微信登录返回的code	|

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| String| 是	|详细信息					|
537 538
| token	| String| -	|登录成功之后返回的token信息|
| tokenExpired	| String| -	|token过期时间|
雪洛's avatar
雪洛 已提交
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643

**示例代码**

```js
// 云函数login-by-weixin代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const res = await uniID.loginByWeixin(event.code)
	return res
}

// 客户端代码
// 代码较长建议直接参考插件市场示例项目:https://ext.dcloud.net.cn/plugin?id=2116
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: '微信登录失败,请稍后再试'
        })
      })
    }
  }
}

```

## 绑定微信

用法:`uniID.bindWeixin(Object weixinInfo);`

**weixinInfo 参数说明**

**参数说明**

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

**响应参数**

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

```js
雪洛's avatar
雪洛 已提交
644
// 云函数代码
雪洛's avatar
雪洛 已提交
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
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.bindWeixin({
    uid: payload.uid,
    code: event.code
  })
	return res
}
```

## 解绑微信

用法:`uniID.unbindWeixin(String uid);`

**参数说明**

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

**响应参数**

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

```js
雪洛's avatar
雪洛 已提交
677
// 云函数代码
雪洛's avatar
雪洛 已提交
678 679 680 681 682 683 684 685 686 687
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.unbindWeixin(payload.uid)
	return res
}
```
雪洛's avatar
雪洛 已提交
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726

## 支付宝登录

用法:`uniID.loginByAlipay(String code);`

**注意**

- 需要在config.json内支付宝平台下配置appid和privateKey(应用私钥)
- 登录成功之后应持久化存储token,键值为:uniIdToken,`uni.removeStorageSync('uniIdToken')`

**参数说明**

| 字段| 类型	| 必填| 说明							|
| ---	| ---		| ---	| ---								|
| code| String| 是	|支付宝登录返回的code	|

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| String| 是	|详细信息					|
| token	| String| -	|登录成功之后返回的token信息|
| tokenExpired	| String| -	|token过期时间|

**示例代码**

```js
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
	const res = await uniID.loginByAlipay(event.code)
	return res
}
```

## 绑定支付宝

用法:`uniID.bindAlipay(Object alipayInfo);`
727

雪洛's avatar
雪洛 已提交
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
**alipayInfo 参数说明**

**参数说明**

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

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| 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.bindAlipay({
    uid: payload.uid,
    code: event.code
  })
	return res
}
```

雪洛's avatar
雪洛 已提交
760
## 解绑支付宝
雪洛's avatar
雪洛 已提交
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788

用法:`uniID.unbindAlipay(String uid);`

**参数说明**

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

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| 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.unbindAlipay(payload.uid)
	return res
}
```
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824

## 更新用户信息

用法:`uniID.updateUser(Object userInfo);`

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

**userInfo参数说明**

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

**响应参数**

| 字段| 类型	| 必填| 说明						|
| ---	| ---		| ---	| ---							|
| code| Number| 是	|错误码,0表示成功|
| msg	| 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.updateUser({
    uid: payload.uid,
    nickname: 'user nickname'
  })
	return res
}
```
W
wanganxp 已提交
825 826 827 828 829 830 831

# 数据库结构

## 用户表

表名:uni-id-users

雪洛's avatar
雪洛 已提交
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
| 字段						| 类型			| 必填| 描述																				|
| ----------------| ---------	| ----| -------------------------------------------	|
| \_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		| 否	| 头像地址																		|
| comment					| String		| 否	| 备注																				|
| wx_openid				| Object		| 否	| 微信平台openid															|
| wx_unionid			| String		| 否	| 微信平台uniodid															|
雪洛's avatar
雪洛 已提交
848
| ali_openid			| String		| 否	| 支付宝平台openid															|
雪洛's avatar
雪洛 已提交
849 850 851 852 853 854 855 856 857 858 859 860
| realname_auth		| Object		| 否	| 实名认证信息																|
| register_date		| Timestamp	| 否	| 注册时间																		|
| register_ip			| String		| 否	| 注册时 IP 地址															|
| last_login_date	| Timestamp	| 否	| 最后登录时间																|
| last_login_ip		| String		| 否	| 最后登录时 IP 地址													|

**wx_openid字段定义**

| 字段    | 类型   | 必填 | 描述     |
| ------- | ------ | ---- | -------- |
| app-plus | String | 否   | app平台微信openid |
| mp-weixin| String | 否   | 微信小程序平台openid  |
W
wanganxp 已提交
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904

**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

}
```