Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Z
zhichan
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
蒋勇
zhichan
Commits
41318641
Commit
41318641
authored
Jul 03, 2020
by
宋毅
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
tj
parent
b50314f3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
0 additions
and
828 deletions
+0
-828
brg-user-center/app/front/entry/public/apidoc/platform/order.md
+0
-365
brg-user-center/app/front/entry/public/apidoc/platform/product.md
+0
-182
brg-user-center/app/front/entry/public/apidoc/platform/user.md
+0
-281
No files found.
brg-user-center/app/front/entry/public/apidoc/platform/order.md
deleted
100755 → 0
View file @
b50314f3
<a
name=
"menu"
href=
"/doc"
>
返回主目录
</a>
1.
[
下商标订单
](
#addOrder
)
1.
[
下其他订单
](
#addOtherOrder
)
1.
[
获取订单列表信息
](
#getOrderInfo
)
1.
[
获取订单详情信息
](
#getOrderDetails
)
1.
[
获取订单操作日志信息
](
#getOrderLogInfo
)
1.
[
删除订单
](
#delOrder
)
## **<a name="addOrder"> 下商标订单</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/opaction/order/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 请求头中需要增加userpin(用户登录后的凭证)的值
#### 渠道执行的类型 actionType:addOrder
```
javascript
{
"channelItemCode"
:
"zzsbzc"
,
// Y 产品的渠道编码
"channelItemAppendName"
:
""
,
// Y 填写的商标名称
"payCode"
:
"zzsbzc-1"
,
// Y 支付价格code
"quantity"
:
1
,
// Y 购买数量
"additions"
:{
// N 附加购买项目
"payCode"
:
"zzsbzc-2"
,
// Y 支付价格code
"quantity"
:
2
// Y 购买数量
},
"totalSum"
:
360
,
// Y 订单总金额---(商标自助注册计算格式:小于10项为产品价格,大于10项的小项数量在additions参数中进行传递)
"payTotalSum"
:
360
,
// Y 订单付款总金额
"notes"
:
"订单备注信息"
,
// N 订单备注
"orderContact"
:{
// Y 订单联系人信息
"contacts"
:
"宋毅"
,
// Y 联系人
"mobile"
:
"15010929368"
,
// Y 联系人电话
"email"
:
"songyi@gongsibao.com"
,
// Y 联系人邮箱
"fax"
:
""
// N 传真
},
"channelOrder"
:{
// Y 渠道订单信息,没有则填写{}
"channelServiceNo"
:
""
,
// N 服务单号(即渠道服务单号)
"channelOrderNo"
:
""
,
// N 服务订单号(即渠道服务订单号,格式为: XX1,XX2)
"needNo"
:
""
,
// N 需求单号(即渠道需求单号)
"payTime"
:
""
,
// N 渠道需求单号支付时间
"orderStatus"
:
1
,
// N 渠道需求单号支付支付状态 1: 待付款, 2: 已付款
"channelParams"
:
""
// N 渠道参数(自定义参数)
},
"deliveryData"
:{
//Y 交付单信息
"apply"
:
{
//申请信息
"applyAddr"
:
"上海市杨浦区国定路346号三楼0624室"
,
//执照详细地址
"applyArea"
:
""
,
//申请区域--暂时没有用到
"businessLicensePic"
:
"https://gsb-zc.oss-cn-beijing.aliyuncs.com/zc_yyzz120315554031547442019316.jpg"
,
//营业执照jpg地址
"businessLicensePdf"
:
"https://gsb-zc.oss-cn-beijing.aliyuncs.com/zc_yyzz120315554031547442019316.pdf"
,
//营业执照pdf地址
"code"
:
"91310110398635929J"
,
//统一社会信用代码
"customerType"
:
"ent"
,
//申请人类型 person个人,ent企业
"identityCardNo"
:
""
,
//申请人身份证号--(申请类型为个人有此值)
"identityCardPic"
:
""
,
//申请人身份证jpg地址--(申请类型为个人有此值)
"identityCardPdf"
:
""
,
//申请人身份证pdf地址 --(申请类型为个人有此值)
"name"
:
"上海辰者信息科技有限公司"
,
//申请人名称
"gzwtsUrl"
:
"https://gsb-zc.oss-cn-beijing.aliyuncs.com/zc_wts863215710393842862019914.jpg"
,
//盖章委托书url
"smwjUrl"
:
""
,
//说明文件url
"zipCode"
:
"100000"
//邮政编码
},
"tm"
:
{
"colorizedPicUrl"
:
"https://gsb-zc.oss-cn-beijing.aliyuncs.com/zc_word2picb2bc98b9fc564ef2a1f4b3cbe9352f39.jpg"
,
//商标彩色图样
"tmName"
:
"testbiao"
,
//商标名称
"picUrl"
:
"https://gsb-zc.oss-cn-beijing.aliyuncs.com/zc_word2picb2bc98b9fc564ef2a1f4b3cbe9352f39.jpg"
,
//商标图样
"tmFormType"
:
"3"
//商标类型形式: "3": 字, "4": 图, "5": 字图
},
"nclones"
:
[
{
"code"
:
"02"
,
//大类编码
"name"
:
"颜料油漆"
,
//大类名称
"nclThree"
:
[
{
"code"
:
"020008"
,
//小项编码
"disabled"
:
"false"
,
"fullname"
:
"020008 绘画用铝粉"
,
//小项编码加名称
"name"
:
"绘画用铝粉"
,
//小项名称
"pcode"
:
"0202"
//小项所属群组编码
},
{
"code"
:
"020005"
,
"disabled"
:
"false"
,
"fullname"
:
"020005 食品用着色剂"
,
"name"
:
"食品用着色剂"
,
"pcode"
:
"0203"
}
]
}
]
}
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"data"
:
{
"orderNo"
:
"OT26202002151649kPgs"
,
//订单号
"channelServiceNo"
:
"OT26202002151649kPgs"
,
//渠道服务单号
"channelOrderNo"
:
"OT26202002151649kPgs"
,
//渠道订单号
"channelParams"
:
""
//渠道参数
},
"requestId"
:
"2f90fad8108b4933bb97c3d978b0fe10"
}
```
## **<a name="addOtherOrder"> 下其他订单</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/opaction/order/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 请求头中需要增加userpin(用户登录后的凭证)的值
#### 渠道执行的类型 actionType:addOrder
```
javascript
{
"channelItemCode"
:
"fzsbzc"
,
// Y 产品的渠道编码
"payCode"
:
"fzsbzc-1"
,
// Y 支付价格code
"quantity"
:
1
,
// Y 购买数量
"totalSum"
:
699
,
// Y 订单总金额
"payTotalSum"
:
699
,
// Y 订单付款总金额
"notes"
:
"订单备注信息"
,
// N 订单备注
"orderContact"
:{
// N 订单联系人信息,没有则填写{}
"contacts"
:
"宋毅"
,
// N 联系人
"mobile"
:
"15010929368"
,
// N 联系人电话
"email"
:
"songyi@gongsibao.com"
// N 联系人邮箱
},
"channelOrder"
:{
// Y 渠道订单信息,没有则填写{}
"channelServiceNo"
:
""
,
// N 服务单号(即渠道服务单号)
"channelOrderNo"
:
""
,
// N 服务订单号(即渠道服务订单号,格式为: XX1,XX2)
"needNo"
:
""
,
// N 需求单号(即渠道需求单号)
"payTime"
:
""
,
// N 渠道需求单号支付时间
"orderStatus"
:
1
,
// N 渠道需求单号支付支付状态 1: 待付款, 2: 已付款
"channelParams"
:
""
// N 渠道参数(自定义参数)
},
"deliveryData"
:{}
//Y 交付单信息,没有则填写{}
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"data"
:
{
"orderNo"
:
"OT26202002151649kPgs"
,
//订单号
"channelServiceNo"
:
"OT26202002151649kPgs"
,
//渠道服务单号
"channelOrderNo"
:
"OT26202002151649kPgs"
,
//渠道订单号
"channelParams"
:
""
//渠道参数
},
"requestId"
:
"2f90fad8108b4933bb97c3d978b0fe10"
}
```
## **<a name="getOrderInfo"> 获取订单列表信息</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/opaction/order/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 请求头中需要增加userpin(用户登录后的凭证)的值
#### 渠道执行的类型 actionType:getOrderInfo
```
javascript
{
"pageIndex"
:
1
,
// Y 当前页{
"pageSize"
:
20
,
// Y 每页大小,最大为50
"channelItemName"
:
""
,
// N 产品名称
"channelServiceNo"
:
""
,
// N 渠道订单号
"orderStatus"
:
""
,
// N 订单状态
"startTime"
:
"2019-10-27"
,
// N 开始时间
"entTime"
:
"2019-10-31"
// N 结束时间
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"dataCount"
:
2
,
//总条数
"data"
:
[
{
"orderNo"
:
"OT31202002191443AVlJ"
,
// 订单号
"channelServiceNo"
:
""
,
//渠道服务号
"channelOrderNo"
:
""
,
//渠道订单号列表,格式:XX1,XX2
"channelUserId"
:
"15010929366"
,
//渠道用户Id
"ownerUserId"
:
"15010929366"
,
//拥有者Id
"payTime"
:
null
,
//支付时间
"quantity"
:
1
,
//订单数量
"serviceQuantity"
:
0
,
//订单服务数量
"orderStatusName"
:
"待付款"
,
//订单状态名称
"orderStatus"
:
1
,
//订单状态编码: 1: 待付款, 2: 已付款, 4: 服务中, 8: 已完成
"totalSum"
:
"10.00"
,
//订单金额
"payTotalSum"
:
"10.00"
,
//订单支付金额
"refundSum"
:
"0.00"
,
//退款金额
"invoiceApplyStatus"
:
"00"
,
//发票申请状态
"opNotes"
:
""
,
//操作备注
"channelItemCode"
:
"FW_GOODS-582221-1"
,
//渠道产品编码
"channelItemName"
:
"京东云PLUS公司注册(北京市)"
,
//渠道产品名称
"channelItemAppendName"
:
"北京海淀"
,
//渠道产品附加名称
"price"
:
"10.00"
,
//产品单价
"priceTypeName"
:
"件"
,
//产品单价单位名称
"priceDesc"
:
"海淀区内资一般人"
,
//产品单价描述
"serviceItemCode"
:
null
,
//服务产品编码
"picUrl"
:
null
,
//产品图片地址
"created_at"
:
""
//下单时间
},
{
"orderNo"
:
"OT31202002191456tDU7"
,
"channelServiceNo"
:
"0001"
,
"channelOrderNo"
:
""
,
"channelUserId"
:
"15010929366"
,
"ownerUserId"
:
"15010929366"
,
"payTime"
:
"2020"
,
"quantity"
:
1
,
"serviceQuantity"
:
0
,
"orderStatusName"
:
"已付款"
,
"orderStatus"
:
2
,
"totalSum"
:
"10.00"
,
"payTotalSum"
:
"10.00"
,
"refundSum"
:
"0.00"
,
"invoiceApplyStatus"
:
"00"
,
"opNotes"
:
""
,
"channelItemCode"
:
"FW_GOODS-582221-1"
,
"channelItemName"
:
"京东云PLUS公司注册(北京市)"
,
"channelItemAppendName"
:
""
,
"price"
:
"10.00"
,
"priceTypeName"
:
"件"
,
"priceDesc"
:
"海淀区内资一般人"
,
"serviceItemCode"
:
null
,
"picUrl"
:
null
,
"created_at"
:
""
}
],
"requestId"
:
"92ced0cb4d地址cb4125a4b515227f3eabe1"
}
```
## **<a name="getOrderDetails"> 获取订单详情信息</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/opaction/order/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 请求头中需要增加userpin(用户登录后的凭证)的值
#### 渠道执行的类型 actionType:getOrderDetails
```
javascript
{
"orderNo"
:
"TM26202002271337mkgN"
// Y 订单号
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"data"
:
{
"orderNo"
:
"OT31202002191443AVlJ"
,
// 订单号
"channelServiceNo"
:
""
,
//渠道服务号
"channelOrderNo"
:
""
,
//渠道订单号列表,格式:XX1,XX2
"channelUserId"
:
"15010929366"
,
//渠道用户Id
"ownerUserId"
:
"15010929366"
,
//拥有者Id
"payTime"
:
null
,
//支付时间
"quantity"
:
1
,
//订单数量
"serviceQuantity"
:
0
,
//订单服务数量
"orderStatusName"
:
"待付款"
,
//订单状态名称
"orderStatus"
:
1
,
//订单状态编码: 1: 待付款, 2: 已付款, 4: 服务中, 8: 已完成
"totalSum"
:
"10.00"
,
//订单金额
"payTotalSum"
:
"10.00"
,
//订单支付金额
"refundSum"
:
"0.00"
,
//退款金额
"invoiceApplyStatus"
:
"00"
,
//发票申请状态
"opNotes"
:
""
,
//操作备注
"channelItemCode"
:
"FW_GOODS-582221-1"
,
//渠道产品编码
"channelItemName"
:
"京东云PLUS公司注册(北京市)"
,
//渠道产品名称
"channelItemAppendName"
:
"北京海淀"
,
//渠道产品附加名称
"price"
:
"10.00"
,
//产品单价
"priceTypeName"
:
"件"
,
//产品单价单位名称
"priceDesc"
:
"海淀区内资一般人"
,
//产品单价描述
"serviceItemCode"
:
null
,
//服务产品编码
"picUrl"
:
null
,
//产品图片地址
"created_at"
:
""
//下单时间
},
"requestId"
:
"92ced0cb4d地址cb4125a4b515227f3eabe1"
}
```
## **<a name="getOrderLogInfo"> 获取订单操作日志信息</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/opaction/order/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 请求头中需要增加userpin(用户登录后的凭证)的值
#### 渠道执行的类型 actionType:getOrderLogInfo
```
javascript
{
"sourceOrderNo"
:
"TM26202002271337mkgN"
// Y 订单号
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"data"
:
[
{
"opContent"
:
"您的订单成功支付,请等待服务人员联系您"
,
// 内容
"created_at"
:
"2020-02-28T18:45:44.000Z"
//创建时间
},
{
"opContent"
:
"您提交了订单,请及时支付"
,
"created_at"
:
"2020-02-25T18:44:45.000Z"
}
],
"requestId"
:
"f21446617c5e46ad889f3fab7bb69456"
}
```
## **<a name="delOrder"> 删除订单</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/opaction/order/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 请求头中需要增加userpin(用户登录后的凭证)的值
#### 渠道执行的类型 actionType:delOrder
```
javascript
{
"orderNo"
:
"TM26202002271337mkgN"
// Y 订单号
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"data"
:
null
,
"requestId"
:
"f21446617c5e46ad889f3fab7bb69456"
}
```
brg-user-center/app/front/entry/public/apidoc/platform/product.md
deleted
100755 → 0
View file @
b50314f3
<a
name=
"menu"
href=
"/doc"
>
返回主目录
</a>
1.
[
产品列表-根据产品大类获取
](
#getProductListByOneCode
)
1.
[
产品列表-根据产品二类获取
](
#getProductListByTwoCode
)
1.
[
产品详情
](
#getProductDetail
)
## **<a name="getProductListByOneCode"> 产品列表-根据产品大类编码获取</a>**
[
返回到目录
](
#menu
)
##### URL
[
/action/product/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:getProductList
```
javascript
{
"pathCode"
:
"sbfu"
//查询的路径:大类code
}
```
#### 返回结果 0为成功,否则为失败
```
javascript
{
"status"
:
0
,
"msg"
:
"success"
,
"data"
:
[
{
"uapp_id"
:
26
,
//平台id--显示不用
"path_code"
:
"/sbfu/sbzc/"
,
//产品路径编码--显示不用
"path_name"
:
"/商标服务/商标注册/"
,
//产品路径名称--显示不用
"item_code"
:
"zzsbzc"
,
//产品code
"item_name"
:
"商标注册【自助申请】"
,
//产品名称
"channel_item_code"
:
"zzsbzc"
,
//渠道产品code
"channel_item_name"
:
"商标注册【自助申请】"
,
//渠道产品名称
"pic_url"
:
"http://gsb-zc.oss-cn-beijing.aliyuncs.com/zc_qft_pi15755163570461.png"
,
//产品的图片
"product_short_desc"
:
"适合熟知商标注册流程的企业用户"
,
//产品的介绍
"product_desc"
:
"[
\"
自己检索商标,准备官方所需注册材料
\"
,
\"
提交迅速,及时反馈
\"
,
\"
全流程跟踪,掌握申请进度
\"
]"
,
//产品的描述列表
"desc_url"
:
null
,
//产品介绍图片地址
"icon_url"
:
null
,
//产品的icon
"productType_id"
:
2
,
//产品类型id--显示用不到
"sort"
:
1
,
//排序
"pay_code"
:
"zzsbzc-1"
,
//支付价格code
"service_charge"
:
30
,
//服务费
"public_expense"
:
270
,
//官费
"price"
:
300
,
//价格
"price_type"
:
"mj"
,
//定价类型:mj:每件,mc:每次,mt:每天,my:每月,mn:每年,qj:区间
"price_type_name"
:
"每件"
,
//定价类型名称
"price_desc"
:
"每件(10小项)"
,
//定价描述
"min_qty"
:
null
,
//区间最小值
"max_qty"
:
null
//区间最大值
}
],
"requestId"
:
"c39ee8a924074904b1694dd3bf2d6c4b"
}
```
## **<a name="getProductListByTwoCode"> 产品列表-根据产品二类获取</a>**
[
返回到目录
](
#menu
)
##### URL
[
/action/product/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:getProductList
```
javascript
{
"pathCode"
:
"sbfu/sbzc"
//查询的路径:大类code/二类code
}
```
#### 返回结果 0为成功,否则为失败
```
javascript
{
"status"
:
0
,
"msg"
:
"success"
,
"data"
:
[
{
"uapp_id"
:
26
,
//平台id--显示不用
"path_code"
:
"/sbfu/sbzc/"
,
//产品路径编码--显示不用
"path_name"
:
"/商标服务/商标注册/"
,
//产品路径名称--显示不用
"item_code"
:
"zzsbzc"
,
//产品code
"item_name"
:
"商标注册【自助申请】"
,
//产品名称
"channel_item_code"
:
"zzsbzc"
,
//渠道产品code
"channel_item_name"
:
"商标注册【自助申请】"
,
//渠道产品名称
"pic_url"
:
"http://gsb-zc.oss-cn-beijing.aliyuncs.com/zc_qft_pi15755163570461.png"
,
//产品的图片
"product_short_desc"
:
"适合熟知商标注册流程的企业用户"
,
//产品的介绍
"product_desc"
:
"[
\"
自己检索商标,准备官方所需注册材料
\"
,
\"
提交迅速,及时反馈
\"
,
\"
全流程跟踪,掌握申请进度
\"
]"
,
//产品的描述列表
"desc_url"
:
null
,
//产品介绍图片地址
"icon_url"
:
null
,
//产品的icon
"productType_id"
:
2
,
//产品类型id--显示用不到
"sort"
:
1
,
//排序
"pay_code"
:
"zzsbzc-1"
,
//支付价格code
"service_charge"
:
30
,
//服务费
"public_expense"
:
270
,
//官费
"price"
:
300
,
//价格
"price_type"
:
"mj"
,
//定价类型:mj:每件,mc:每次,mt:每天,my:每月,mn:每年,qj:区间
"price_type_name"
:
"每件"
,
//定价类型名称
"price_desc"
:
"每件(10小项)"
,
//定价描述
"min_qty"
:
null
,
//区间最小值
"max_qty"
:
null
//区间最大值
}
],
"requestId"
:
"c39ee8a924074904b1694dd3bf2d6c4b"
}
```
## **<a name="getProductDetail"> 产品详情</a>**
[
返回到目录
](
#menu
)
##### URL
[
/action/product/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:getProductDetail
```
javascript
{
"channelItemCode"
:
"zzsbzc"
}
```
#### 返回结果 0为成功,否则为失败
```
javascript
{
"status"
:
0
,
"msg"
:
"success"
,
"data"
:
{
"id"
:
1
,
//产品Id
"uapp_id"
:
26
,
"path_code"
:
"/sbfu/sbzc/"
,
"path_name"
:
"/商标服务/商标注册/"
,
"item_code"
:
"zzsbzc"
,
"item_name"
:
"商标注册【自助申请】"
,
"channel_item_code"
:
"zzsbzc"
,
"channel_item_name"
:
"商标注册【自助申请】"
,
"pic_url"
:
"http://gsb-zc.oss-cn-beijing.aliyuncs.com/zc_qft_pi15755163570461.png"
,
"product_short_desc"
:
"适合熟知商标注册流程的企业用户"
,
//产品的介绍
"product_desc"
:
"[
\"
自己检索商标,准备官方所需注册材料
\"
,
\"
提交迅速,及时反馈
\"
,
\"
全流程跟踪,掌握申请进度
\"
]"
,
//产品的描述列表
"desc_url"
:
null
,
"icon_url"
:
null
,
"productType_id"
:
2
,
"price_list"
:
[
{
"pay_code"
:
"zzsbzc-1"
,
//支付价格code
"price"
:
300
,
"supply_price"
:
270
,
"service_charge"
:
30
,
"public_expense"
:
270
,
"is_default"
:
1
,
//是否默认,1默认,0不是默认
"is_show"
:
1
,
//是否显示在页面进行下单(1是,0不是,0为下单时附加的购买项目)
"price_type"
:
"mj"
,
"price_type_name"
:
"每件"
,
"sort"
:
1
,
"price_desc"
:
"每件(10小项)"
,
"min_qty"
:
null
,
"max_qty"
:
null
},
{
"pay_code"
:
"zzsbzc-2"
,
//支付价格code
"price"
:
30
,
"supply_price"
:
30
,
"service_charge"
:
30
,
"public_expense"
:
30
,
"is_default"
:
0
,
"is_show"
:
0
,
"price_type"
:
"mx"
,
"price_type_name"
:
"项"
,
"sort"
:
2
,
"price_desc"
:
"每个小项的价格"
,
"min_qty"
:
null
,
"max_qty"
:
null
}
]
},
"requestId"
:
"5913fc3ae97a402e93330c2d488f1f7e"
}
```
\ No newline at end of file
brg-user-center/app/front/entry/public/apidoc/platform/user.md
deleted
100755 → 0
View file @
b50314f3
<a
name=
"menu"
href=
"/doc"
>
返回主目录
</a>
1.
[
短信验证码
](
#smsCode
)
1.
[
密码登录
](
#pwdLogin
)
1.
[
验证码登录
](
#userPinByLgoinVcode
)
1.
[
用户注册
](
#userPinByRegister
)
1.
[
按照手机号和验证码修改密码
](
#putUserPwdByMobile
)
1.
[
获取用户登录信息
](
#getLoginInfo
)
1.
[
退出
](
#logout
)
1.
[
飞书登录
](
#feishuLogin
)
## **<a name="smsCode"> 短信验证码</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/auth/accessAuth/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:getVerifyCode
```
javascript
{
"mobile"
:
"15010929366"
// Y 手机号
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"data"
:
null
,
"requestId"
:
"4f3ea2afee3542f88d6b938394af84d8"
}
```
## **<a name="pwdLogin"> 帐号密码登录</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/auth/accessAuth/springBoard
]
#### 参数格式 `JSON`getVerifyCode
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:userPinByLgoin
```
javascript
{
"userName"
:
"15010929366"
,
// Y 用户名
"password"
:
"123456"
// Y 密码
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,2010为账户或密码错误,2060为重复登录,否则失败
"msg"
:
"success"
,
"data"
:
{
"userpin"
:
"230ecdf3333944ff834f56fba10a02aa"
//用户登录后的凭证,增、删、改、查、涉及用户的需要传递此值在请求头中
},
"requestId"
:
"1b12b0e9c190436da000386ddf693c8f"
}
```
## **<a name="userPinByLgoinVcode"> 验证码登录</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/auth/accessAuth/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:userPinByLgoinVcode
```
javascript
{
"mobile"
:
"15010929366"
,
// Y 手机号
"vcode"
:
"593555"
// Y 验证码
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,2030为验证码错误,2060为重复登录,否则失败
"msg"
:
"success"
,
"data"
:
{
"userpin"
:
"230ecdf3333944ff834f56fba10a02aa"
//用户登录后的凭证,增、删、改、查、涉及用户的需要传递此值在请求头中
},
"requestId"
:
"1b12b0e9c190436da000386ddf693c8f"
}
```
## **<a name="userPinByRegister"> 用户注册</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/auth/accessAuth/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:userPinByRegister
```
javascript
{
"mobile"
:
"15010929366"
,
// Y 手机号
"vcode"
:
"593555"
,
// Y 验证码
"password"
:
"123456"
// Y 密码
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,2030为验证码错误,2000为已经存在此用户,注册失败,否则失败
"msg"
:
"success"
,
"data"
:
{
"userpin"
:
"230ecdf3333944ff834f56fba10a02aa"
//用户登录后的凭证,增、删、改、查、涉及用户的需要传递此值在请求头中
},
"requestId"
:
"1b12b0e9c190436da000386ddf693c8f"
}
```
## **<a name="putUserPwdByMobile"> 按照手机号和验证码修改密码(修改后得重新登录)</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/auth/accessAuth/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:putUserPwdByMobile
```
javascriptgetVerifyCode
{
"mobile":"15010929366", // Y 手机号
"vcode":"593555", // Y 验证码
"newPwd":"123456" // Y 新密码
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,2030为验证码错误,否则失败
"msg"
:
"success"
,
"data"
:
null
,
"requestId"
:
"1b12b0e9c190436da000386ddf693c8f"
}
```
## **<a name="logout"> 退出</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/auth/accessAuth/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:logout
```
javascript
{
"userpin"
:
"15010929366"
// Y 用户登录凭证key
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"data"
:
null
,
"requestId"
:
"1b12b0e9c190436da000386ddf693c8f"
}
```
## **<a name="getLoginInfo"> 获取用户登录信息</a>**
[
返回到目录
](
#menu
)
##### URL
[
/web/auth/accessAuth/springBoard
]
#### 参数格式 `JSON`
#### HTTP请求方式 `POST`
#### 渠道执行的类型 actionType:getLoginInfo
```
javascript
{
"userpin"
:
"15010929366"
// Y 用户登录凭证key
}
```
#### 返回结果
```
javascript
{
"status"
:
0
,
// 0为成功,否则失败
"msg"
:
"success"
,
"data"
:
{
"id"
:
9
,
"uapp_id"
:
26
,
"channel_userid"
:
"15010929366"
,
//渠道用户ID
"channel_username"
:
"15010929366"
,
//账户
"channel_nickname"
:
""
,
"open_id"
:
null
,
"head_url"
:
null
,
"mobile"
:
"15010929366"
,
//手机号
"org_name"
:
""
,
"org_path"
:
""
,
"email"
:
""
,
"is_admin"
:
0
,
//是否管理员
"is_super"
:
0
,
//是否超级管理员
"is_enabled"
:
1
,
"userpin"
:
"18c44186d54a45ea8777ef4c0a4252f6"
//用户登录后的凭证key
},
"requestId"
:
"ad31ced9ac7044f69f453185d9c1e241"
}
```
## **<a name="feishuLogin"> 飞书登录</a>**
[
返回到目录
](
#menu
)
##### URL
[
http://feishu.qifu.gongsibao.com:4012/feishu/login?code={code}&state={state}&open_id={open_id}
]
#### HTTP请求方式 `GET`
```
javascript
请求参数说明
:
code
:
用户飞书登录预授权码
必填
state
:
前端获取的
token
信息
必填
open_id
:
用户
openid
非必填
```
#### 返回结果
```
javascript
{
"status"
:
0
,
"msg"
:
"success"
,
"data"
:{
"userpin"
:
"1508e7f73efd49cda8d2bc7d2552b09b"
}
}
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment