client/docs/passport/account.md

162 lines
3.2 KiB
Markdown
Raw Normal View History

# Account
2025-09-07 22:03:28 +08:00
Passport(会员通行证)模块-数据
- [/passport.Account/Get](#passportaccountget)
- [/passport.Account/SetData](#passportaccountsetdata)
- [/passport.Account/SetPassword](#passportaccountsetpassword)
2025-09-12 23:58:38 +08:00
- [/passport.Account/TagCreate](#passportaccounttagcreate)
- [/passport.Account/TagRemove](#passportaccounttagremove)
- [/passport.Account/Statistics](#passportaccountstatistics)
2025-09-07 22:03:28 +08:00
## /passport.Account/Get
2025-09-07 22:03:28 +08:00
通过会员所有信息
2025-09-07 22:03:28 +08:00
### Request
```javascript
{}
```
### Reply
```javascript
{
identity: "", // type<string>, 唯一标识
2025-09-07 22:03:28 +08:00
account: "", // type<string>, 帐号
phone: "", // type<string>, 手机号码 必填
email: "", // type<string>, 验证码
rights: "", // type<string>, 权限
2025-09-07 22:03:28 +08:00
nickname: "", // type<string>, 昵称
avatar: "", // type<string>, 头像
birthday: "", // type<string>, 生日
sex: 0, // type<int32>, 性别1为男性2为女性
country: 0, // type<int32>, 国家
2025-09-07 22:03:28 +08:00
province: 0, // type<int32>, 省
city: 0, // type<int32>, 市
area: 0, // type<int32>, 区
sign: "", // type<string>, 签名
cover: "", // type<string>, 背景&封面
score: 0, // type<int32>, 积分
level: 0, // type<int32>, 等级
verify: {
"": false
}, // map<string,bool>, 数据
2025-09-12 23:00:23 +08:00
tags: [{
2025-09-12 23:58:38 +08:00
name: "", // type<string>
icon: "", // type<string>
2025-09-12 23:00:23 +08:00
}], // list<TagItem>
2025-09-07 22:03:28 +08:00
}
```
## /passport.Account/SetData
2025-09-07 22:03:28 +08:00
更新会员的信息数据,字段值为空或是0将不更新此数据
2025-09-07 22:03:28 +08:00
### Request
```javascript
{
nickname: "", // type<string>, 昵称
avatar: "", // type<string>, 头像
birthday: "", // type<string>, 生日
sex: 0, // type<int32>, 性别1为男性2为女性
2025-09-12 23:58:38 +08:00
country: 0, // type<int32>, 国家
2025-09-07 22:03:28 +08:00
province: 0, // type<int32>, 省
city: 0, // type<int32>, 市
area: 0, // type<int32>, 区
sign: "", // type<string>, 签名
2025-09-12 23:58:38 +08:00
cover: "", // type<string>, 背景&封面
score: 0, // type<int32>, 积分
level: 0, // type<int32>, 等级
2025-09-07 22:03:28 +08:00
}
```
### Reply
```javascript
{
2025-09-12 23:58:38 +08:00
data: "", // type<string>, 数据
2025-09-07 22:03:28 +08:00
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /passport.Account/SetPassword
2025-09-07 22:03:28 +08:00
更新会员的密码
### Request
```javascript
{
old_password: "", // type<string>, 旧密码
new_password: "", // type<string>, 新密码
}
```
### Reply
```javascript
{
2025-09-12 23:58:38 +08:00
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /passport.Account/TagCreate
新增标签
### Request
```javascript
{
name: "", // type<string>
icon: "", // type<string>
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /passport.Account/TagRemove
删除标签
### Request
```javascript
{
id: "0", // type<int64>, 唯一ID
identity: "", // type<string>, 唯一码
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
2025-09-07 22:03:28 +08:00
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /passport.Account/Statistics
2025-09-07 22:03:28 +08:00
获取会员的相关统计数据
### Request
```javascript
{
field: [""], // list<string>, 要获取的统计数据字段。
}
```
### Reply
```javascript
{
Data: {
"": "0"
}, // map<string,int64>, 数据以Map格式输出
}
```