build pb shell
This commit is contained in:
173
sdk/docs/passport/account.md
Normal file
173
sdk/docs/passport/account.md
Normal file
@@ -0,0 +1,173 @@
|
||||
# Account
|
||||
|
||||
assport通行证模块-帐号数据
|
||||
|
||||
- [/passport.Account/Get](#passportaccountget)
|
||||
- [/passport.Account/SetData](#passportaccountsetdata)
|
||||
- [/passport.Account/SetPassword](#passportaccountsetpassword)
|
||||
- [/passport.Account/TagCreate](#passportaccounttagcreate)
|
||||
- [/passport.Account/TagRemove](#passportaccounttagremove)
|
||||
- [/passport.Account/Statistics](#passportaccountstatistics)
|
||||
|
||||
## /passport.Account/Get
|
||||
|
||||
通过会员所有信息
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
identity: "", // type<string>, 唯一标识
|
||||
account: "", // type<string>, 帐号
|
||||
phone: "", // type<string>, 手机号码 必填
|
||||
email: "", // type<string>, 验证码
|
||||
rights: "", // type<string>, 权限
|
||||
nickname: "", // type<string>, 昵称
|
||||
avatar: "", // type<string>, 头像
|
||||
birthday: "", // type<string>, 生日
|
||||
sex: 0, // type<int32>, 性别，1为男性，2为女性
|
||||
country: "", // type<string>, 国家
|
||||
province: "", // type<string>, 省
|
||||
city: "", // type<string>, 市
|
||||
area: "", // type<string>, 区
|
||||
sign: "", // type<string>, 签名
|
||||
cover: "", // type<string>, 背景&封面
|
||||
score: 0, // type<int32>, 积分
|
||||
level: 0, // type<int32>, 等级
|
||||
verify_status: {
|
||||
email_verify: 0, // type<int32>, 邮箱是否已验证
|
||||
phone_verify: 0, // type<int32>, 手机是否已验证
|
||||
face_verify: 0, // type<int32>, 人脸或照片是否已验证
|
||||
document_verify: 0, // type<int32>, 证件是否已验证
|
||||
kyc_verify: 0, // type<int32>, 实名是否已验证
|
||||
}, // type<VerifyStatus>, 用户验证状态
|
||||
tags: [{
|
||||
name: "", // type<string>
|
||||
icon: "", // type<string>
|
||||
}], // list<TagItem>, 用户标签
|
||||
}
|
||||
```
|
||||
## /passport.Account/SetData
|
||||
|
||||
更新会员的信息数据,字段值为空或是0，将不更新此数据
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
nickname: "", // type<string>, 昵称
|
||||
avatar: "", // type<string>, 头像
|
||||
birthday: "", // type<string>, 生日
|
||||
sex: 0, // type<int32>, 性别，1为男性，2为女性
|
||||
country: "", // type<string>, 国家
|
||||
province: "", // type<string>, 省
|
||||
city: "", // type<string>, 市
|
||||
area: "", // type<string>, 区
|
||||
sign: "", // type<string>, 签名
|
||||
cover: "", // type<string>, 背景&封面
|
||||
score: 0, // type<int32>, 积分
|
||||
level: 0, // type<int32>, 等级
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
code: 0, // type<int32>, 状态码
|
||||
message: "", // type<string>, 状态说明
|
||||
details: "", // type<string>, 数据
|
||||
timeseq: "0", // type<int64>, 响应时间序列
|
||||
}
|
||||
```
|
||||
## /passport.Account/SetPassword
|
||||
|
||||
更新会员的密码
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
old_password: "", // type<string>, 旧密码
|
||||
new_password: "", // type<string>, 新密码
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
code: 0, // type<int32>, 状态码
|
||||
message: "", // type<string>, 状态说明
|
||||
details: "", // type<string>, 数据
|
||||
timeseq: "0", // type<int64>, 响应时间序列
|
||||
}
|
||||
```
|
||||
## /passport.Account/TagCreate
|
||||
|
||||
新增标签
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
name: "", // type<string>
|
||||
icon: "", // type<string>
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
code: 0, // type<int32>, 状态码
|
||||
message: "", // type<string>, 状态说明
|
||||
details: "", // type<string>, 数据
|
||||
timeseq: "0", // type<int64>, 响应时间序列
|
||||
}
|
||||
```
|
||||
## /passport.Account/TagRemove
|
||||
|
||||
删除标签
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
id: "0", // type<int64>, 唯一ID
|
||||
identity: "", // type<string>, 唯一码
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
code: 0, // type<int32>, 状态码
|
||||
message: "", // type<string>, 状态说明
|
||||
details: "", // type<string>, 数据
|
||||
timeseq: "0", // type<int64>, 响应时间序列
|
||||
}
|
||||
```
|
||||
## /passport.Account/Statistics
|
||||
|
||||
获取会员的相关统计数据
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
field: [""], // list<string>, 要获取的统计数据字段。
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
Data: {
|
||||
"": "0"
|
||||
}, // map<string,int64>, 数据以Map格式输出
|
||||
}
|
||||
```
|
||||
|
||||
52
sdk/docs/passport/forget.md
Normal file
52
sdk/docs/passport/forget.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Forget
|
||||
|
||||
Passport通行证模块-找回密码
|
||||
|
||||
- [/passport.Forget/Verify](#passportforgetverify)
|
||||
- [/passport.Forget/Reset](#passportforgetreset)
|
||||
|
||||
## /passport.Forget/Verify
|
||||
|
||||
验证手机号和验证码
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
phone: "", // type<string>, 手机号
|
||||
code: "", // type<string>, 验证码
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
code: 0, // type<int32>, 状态码
|
||||
message: "", // type<string>, 状态说明
|
||||
details: "", // type<string>, 数据
|
||||
timeseq: "0", // type<int64>, 响应时间序列
|
||||
}
|
||||
```
|
||||
## /passport.Forget/Reset
|
||||
|
||||
重罢密码
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
identity: "", // type<string>, 唯一码
|
||||
password: "", // type<string>, 密码
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
code: 0, // type<int32>, 状态码
|
||||
message: "", // type<string>, 状态说明
|
||||
details: "", // type<string>, 数据
|
||||
timeseq: "0", // type<int64>, 响应时间序列
|
||||
}
|
||||
```
|
||||
|
||||
112
sdk/docs/passport/login.md
Normal file
112
sdk/docs/passport/login.md
Normal file
@@ -0,0 +1,112 @@
|
||||
# Login
|
||||
|
||||
Passport-通行证模块-登录
|
||||
|
||||
- [/passport.Login/Pwd](#passportloginpwd)
|
||||
- [/passport.Login/Code](#passportlogincode)
|
||||
- [/passport.Login/Quick](#passportloginquick)
|
||||
|
||||
## /passport.Login/Pwd
|
||||
|
||||
通过密码登录
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
account: "", // type<string>, 账号 必填
|
||||
password: "", // type<string>, 密码 必填
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
id: "0", // type<int64>
|
||||
identity: "", // type<string>, 用户唯一码
|
||||
token: "", // type<string>, 用户凭证
|
||||
extend: {
|
||||
"": ""
|
||||
}, // map<string,string>, 扩展字段
|
||||
verify_status: {
|
||||
email_verify: 0, // type<int32>, 邮箱是否已验证
|
||||
phone_verify: 0, // type<int32>, 手机是否已验证
|
||||
face_verify: 0, // type<int32>, 人脸或照片是否已验证
|
||||
document_verify: 0, // type<int32>, 证件是否已验证
|
||||
kyc_verify: 0, // type<int32>, 实名是否已验证
|
||||
}, // type<VerifyStatus>, 用户验证状态
|
||||
}
|
||||
```
|
||||
## /passport.Login/Code
|
||||
|
||||
通过验证码登录
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
country: "", // type<string>, 国家
|
||||
phone: "", // type<string>, 手机号码
|
||||
code: "", // type<string>, 验证码
|
||||
agency_id: "0", // type<int64>, 代理ID
|
||||
staff_id: "0", // type<int64>, 工作人员ID
|
||||
owner_id: "0", // type<int64>, 所属ID
|
||||
owner_identity: "", // type<string>, 所属唯一码
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
id: "0", // type<int64>
|
||||
identity: "", // type<string>, 用户唯一码
|
||||
token: "", // type<string>, 用户凭证
|
||||
extend: {
|
||||
"": ""
|
||||
}, // map<string,string>, 扩展字段
|
||||
verify_status: {
|
||||
email_verify: 0, // type<int32>, 邮箱是否已验证
|
||||
phone_verify: 0, // type<int32>, 手机是否已验证
|
||||
face_verify: 0, // type<int32>, 人脸或照片是否已验证
|
||||
document_verify: 0, // type<int32>, 证件是否已验证
|
||||
kyc_verify: 0, // type<int32>, 实名是否已验证
|
||||
}, // type<VerifyStatus>, 用户验证状态
|
||||
}
|
||||
```
|
||||
## /passport.Login/Quick
|
||||
|
||||
通过验证码快捷登录并注册
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
country: "", // type<string>, 国家
|
||||
phone: "", // type<string>, 手机号码
|
||||
code: "", // type<string>, 验证码
|
||||
agency_id: "0", // type<int64>, 代理ID
|
||||
staff_id: "0", // type<int64>, 工作人员ID
|
||||
owner_id: "0", // type<int64>, 所属ID
|
||||
owner_identity: "", // type<string>, 所属唯一码
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
id: "0", // type<int64>
|
||||
identity: "", // type<string>, 用户唯一码
|
||||
token: "", // type<string>, 用户凭证
|
||||
extend: {
|
||||
"": ""
|
||||
}, // map<string,string>, 扩展字段
|
||||
verify_status: {
|
||||
email_verify: 0, // type<int32>, 邮箱是否已验证
|
||||
phone_verify: 0, // type<int32>, 手机是否已验证
|
||||
face_verify: 0, // type<int32>, 人脸或照片是否已验证
|
||||
document_verify: 0, // type<int32>, 证件是否已验证
|
||||
kyc_verify: 0, // type<int32>, 实名是否已验证
|
||||
}, // type<VerifyStatus>, 用户验证状态
|
||||
}
|
||||
```
|
||||
|
||||
86
sdk/docs/passport/register.md
Normal file
86
sdk/docs/passport/register.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# Register
|
||||
|
||||
Passport-通行证模块-注册
|
||||
|
||||
- [/passport.Register/Pwd](#passportregisterpwd)
|
||||
- [/passport.Register/Code](#passportregistercode)
|
||||
|
||||
## /passport.Register/Pwd
|
||||
|
||||
帐号密码注册
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
country: "", // type<string>, 国家码,eg CN US
|
||||
email: "", // type<string>, 邮箱
|
||||
account: "", // type<string>, 帐号
|
||||
phone: "", // type<string>, 手机号
|
||||
password: "", // type<string>, 密码
|
||||
code: "", // type<string>, 验证码
|
||||
agency_id: "0", // type<int64>, 代理ID
|
||||
staff_id: "0", // type<int64>, 工作人员ID
|
||||
owner_id: "0", // type<int64>, 所属ID
|
||||
owner_identity: "", // type<string>, 所属唯一码
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
id: "0", // type<int64>
|
||||
identity: "", // type<string>, 用户唯一码
|
||||
token: "", // type<string>, 用户Header所需Token
|
||||
extend: {
|
||||
"": ""
|
||||
}, // map<string,string>, 扩展字段
|
||||
verify_status: {
|
||||
email_verify: 0, // type<int32>, 邮箱是否已验证
|
||||
phone_verify: 0, // type<int32>, 手机是否已验证
|
||||
face_verify: 0, // type<int32>, 人脸或照片是否已验证
|
||||
document_verify: 0, // type<int32>, 证件是否已验证
|
||||
kyc_verify: 0, // type<int32>, 实名是否已验证
|
||||
}, // type<VerifyStatus>, 用户验证状态
|
||||
}
|
||||
```
|
||||
## /passport.Register/Code
|
||||
|
||||
手机验证码注册
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
country: "", // type<string>, 国家码,eg CN US
|
||||
email: "", // type<string>, 邮箱
|
||||
account: "", // type<string>, 帐号
|
||||
phone: "", // type<string>, 手机号
|
||||
password: "", // type<string>, 密码
|
||||
code: "", // type<string>, 验证码
|
||||
agency_id: "0", // type<int64>, 代理ID
|
||||
staff_id: "0", // type<int64>, 工作人员ID
|
||||
owner_id: "0", // type<int64>, 所属ID
|
||||
owner_identity: "", // type<string>, 所属唯一码
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
id: "0", // type<int64>
|
||||
identity: "", // type<string>, 用户唯一码
|
||||
token: "", // type<string>, 用户Header所需Token
|
||||
extend: {
|
||||
"": ""
|
||||
}, // map<string,string>, 扩展字段
|
||||
verify_status: {
|
||||
email_verify: 0, // type<int32>, 邮箱是否已验证
|
||||
phone_verify: 0, // type<int32>, 手机是否已验证
|
||||
face_verify: 0, // type<int32>, 人脸或照片是否已验证
|
||||
document_verify: 0, // type<int32>, 证件是否已验证
|
||||
kyc_verify: 0, // type<int32>, 实名是否已验证
|
||||
}, // type<VerifyStatus>, 用户验证状态
|
||||
}
|
||||
```
|
||||
|
||||
77
sdk/docs/passport/verify.md
Normal file
77
sdk/docs/passport/verify.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Verify
|
||||
|
||||
Passport(会员通行证)-验证
|
||||
|
||||
- [/passport.Verify/Request](#passportverifyrequest)
|
||||
- [/passport.Verify/JumioCallback](#passportverifyjumiocallback)
|
||||
|
||||
## /passport.Verify/Request
|
||||
|
||||
认证请求
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
provider: "", // type<string>, 服务提供商
|
||||
args: {
|
||||
"": ""
|
||||
}, // map<string,string>, 参数
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
code: 0, // type<int32>, 状态码
|
||||
message: "", // type<string>, 状态说明
|
||||
details: "", // type<string>, 数据
|
||||
timeseq: "0", // type<int64>, 响应时间序列
|
||||
}
|
||||
```
|
||||
## /passport.Verify/JumioCallback
|
||||
|
||||
KYC 认证回调
|
||||
|
||||
|
||||
### Request
|
||||
```javascript
|
||||
{
|
||||
scan_reference: "", // type<string>
|
||||
customer_internal_reference: "", // type<string>
|
||||
verification_status: {
|
||||
state: "", // type<string>, "PENDING", "DONE", "FAILED"
|
||||
reason: "", // type<string>, 可选字段，失败原因
|
||||
}, // type<VerificationStatus>
|
||||
document: {
|
||||
status: "", // type<string>, "APPROVED_VERIFIED", "DENIED_FRAUD", etc.
|
||||
type: "", // type<string>, "PASSPORT", "DRIVER_LICENSE", etc.
|
||||
issuing_country: "", // type<string>
|
||||
number: "", // type<string>
|
||||
}, // type<Document>
|
||||
// 其他可选字段
|
||||
personal_information: {
|
||||
first_name: "", // type<string>
|
||||
last_name: "", // type<string>
|
||||
date_of_birth: "", // type<string>
|
||||
nationality: "", // type<string>
|
||||
}, // type<PersonalInformation>
|
||||
face_map: {
|
||||
status: "", // type<string>
|
||||
similarity: 0.0, // type<float>, 人脸比对相似度
|
||||
}, // type<FaceMap>
|
||||
callback_date: "", // type<string>
|
||||
client_ip: "", // type<string>
|
||||
}
|
||||
```
|
||||
|
||||
### Reply
|
||||
```javascript
|
||||
{
|
||||
code: 0, // type<int32>, 状态码
|
||||
message: "", // type<string>, 状态说明
|
||||
details: "", // type<string>, 数据
|
||||
timeseq: "0", // type<int64>, 响应时间序列
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user