Skip to content

honest_dong / accountDocs

Go to a project
Commit 4ca3f7d4 by dongzhengcheng
Options

api接口文档

parents
Showing with 1066 additions and 0 deletions
docs/apis/account/accountBank.md 0 → 100644
##accountBank
**简要描述：**
10、账户白名单维护
**请求URL：**
- ` /api/account/bank`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P|公司C|会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|bank_no |否|string |行号|
|bank_Name |否|string |行名|
|bank_Account_no |否|string |户号|
|bank_Account_name |否|string |户名|
|type|否|string |操作：1增加，2修改，3删除|
|op_user |是|int | 操作者|
保证金额账户：items_type, items_id ,section_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountDestory.md 0 → 100644
##accountDestory
**简要描述：**
4、销户
正常子账户，通过 BELONG_TYPE，BEKONG_ID, ACCOUNT_TYPE 维护，保证金账户，通过item_type, items_id, 维护
**请求URL：**
- ` /api/account/destory`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P|公司C|会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|is_force |否|int | 1：强制刷新（从银行获取），0非强制刷新。|
|op_user |是|int | 操作者|
保证金额账户：items_type, items_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountInfo.md 0 → 100644
##accountInfo
3、账户信息-账户信息
**简要描述：**
正常子账户，通过 BELONG_TYPE，BEKONG_ID, ACCOUNT_TYPE 维护，保证金账户，通过item_type, items_id, section_id
**请求URL：**
- ` /api/account/info`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P|公司C|会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|name |是|string（20） | 账户名称 |
|user_account|是|string（20） | 平台会员号|
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|is_force |否|int | 1：强制刷新（从银行获取），0非强制刷新。|
|op_user |是|int | 操作者|
保证金额账户：items_type, items_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
'name':'账户名称',
'account_sn':'虚拟号',
'user_account':'会员号',
'bank_code':'银行类型',
'account_no':'银行虚拟子账号',
'gross_amount':'账户总额',
'amount':'可用金额',
'lock_amount':'冻结金额',
'deposit':
{
'items_type':'项目类型',
'items_id':'项目类型',
'tender_uid':'投标人id',
'tender_cid':'投标人公司ID',
'tender_name':'投标人名称',
'section_id':'标段ID',
'section_name':'标段号'
},
'bank':
{
'bank_name':'银行名称',
'bank_no':'银行行号',
'account_name':'账户名称',
'account_no':'账户号',
}
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
|--name|是|string |户名|
|--account_sn|是|string |虚拟账户|
|--user_account|是|string |会员号|
|--gross_amount|是|string |账户总额|
|--amount|是|string |可用金额|
|--lock_amount|是|string |锁定金额|
|--deposit|否|string |保证金账户|
|----items_type|是|string |项目类型|
|----items_id|是|string |项目ID|
|----tender_uid|是|string |投标人ID|
|----tender_name|是|string |投标人名称|
|----section_id|是|string |标段ID|
|----section_name|是|string |标段ID|
|--bank_name|是|string |银行名称|
|--bank_no|是|string |银行虚拟账户|
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountInterest.md 0 → 100644
##accountInterest
5、账户利息试算
**简要描述：**
正常子账户，通过 BELONG_TYPE，BEKONG_ID, ACCOUNT_TYPE 维护，保证金账户，通过item_type, items_id, 维护
**请求URL：**
- ` /api/account/interest`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P|公司C|会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|op_user |是|int | 操作者|
保证金额账户：items_type, items_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
insterst:1.000001
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
|-- insterst|是|float| 利息 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountLocking.md 0 → 100644
##accountLocking
**简要描述：**
8、账户冻结
**请求URL：**
- ` /api/account/locking`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P、公司C、会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|amount |是|int |冻结金额|
|lock_sn |否|string(60) |冻结编号|
|remark |否|string ||
|op_user |是|int | 操作者|
保证金额账户：items_type, items_id ,section_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
账户信息
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountLockingList.md 0 → 100644
##accountLockingList
**简要描述：**
7、账户冻结列表
**请求URL：**
- ` /api/account/locking`
**请求方式：**
- get
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P、公司C、会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|page_num |否|int |页码|
保证金额账户：items_type, items_id ,section_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
"total":3,
"per_page":20,
"current_page":1,
"last_page":1,
"from":1,
"to":3,
"data":[
{
'id':1,
'lock_sn':'冻结编号',
'amount':'冻结金额',
'remark':'备注',
'op_at':'操作时间',
'status':'状态：-1失败，1冻结成功，2已解冻',
}
]
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountLog.md 0 → 100644
##accountLog
**简要描述：**
6、账户流水
**请求URL：**
- ` /api/account/log`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P、公司C、会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|start_at |否|string |开始时间|
|end_at |否|string | 结束时间|
|page_num |否|string |页码|
|op_user |是|int | 操作者|
保证金额账户：items_type, items_id ,section_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
"total":3,
"per_page":20,
"current_page":1,
"last_page":1,
"from":1,
"to":3,
"data":[
{
'id':1,
'bank_code':'银行编号-中信，招行',
'bank_seq_num':'银行流水',
'subject:'标题',
'account_sn':'账户编号',
'is_plus:'出金|入金',
'op_at':'操作时间',
'amount:'金额',
'logs_type:'充值，支付，保证金，取现，退款，利息，手续费',
'in_name':'账户名',
'in_account':'账户号',
'in_bank_no':'行号',
'in_bank_name':'行名',
'out_name':'账户名',
'out_account':'账户号',
'out_bank_no':'行号',
'out_bank_name':'行名',
'cpy_no':'第三方流水',
'remark':'账户编号',
}
]
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
|-- total|是|int| 总条数|
|-- per_page|是|int| 每页条数|
|-- current_page|是|int| 当前页面 |
|-- last_page|是|int| 最后一页|
|-- from|是|int|起止条数 |
|-- to|是|int| 终止条数|
|-- data|是|int| 内容|
|-- -- id|是|int| 总条数|
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountOpen.md 0 → 100644
##accountOpen
1、开户 - 虚拟账户
**简要描述：**
**请求URL：**
- ` /api/account/open`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P、公司C、会员M |
|belong_id |是|int(10) | 对应ID|
|belong_name |否|string(10) |会员|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|name |是|string（20） | 账户名称 |
|user_account|是|string（20） | 平台会员号|
|bank_type |是|string(10) |开户银行|
|items_type |否|string(60) |保证金项目类型 |
|items_id |否|int | 项目ID|
|section_id |否|string | 标段ID|
|tender_cid |否|int | 投标人公司ID|
|tender_uid |否|int | 投标人ID|
|tender_name |否|int | 投标人ID|
|section_name |否|string | 标号+投标人户名|
|op_user |是|int | 操作者|
平台专用账户: P, ID 需要先向虚拟子账户平台申请分配；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
虚拟账户基本信息-见账户信息
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountUnlocking.md 0 → 100644
##accountUnlocking
**简要描述：**
9、账户解冻
**请求URL：**
- ` /api/account/unlocking`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P|公司C|会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|lock_sn|否|string | 冻结业务编号|
|remark|否|string | 备注|
|op_user |是|int | 操作者|
保证金额账户：items_type, items_id ,section_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/account/accountUpdate.md 0 → 100644
####accountUpdate
维护账户信息 - 虚拟账户
**简要描述：**
维护手机号，账户名称；
正常子账户，通过 BELONG_TYPE，BEKONG_ID, ACCOUNT_TYPE 维护，保证金账户，通过item_type, items_id, section_id 维护
**请求URL：**
- ` /api/account/update`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|account_sn |是|string（10） | |
|name |是|string（20） | 账户名称 |
|user_account|是|string（20） | 平台会员号|
|op_user |是|int | 操作者|
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|belong_type |是|string（10） | 所属类型：平台P|公司C|会员M |
|belong_id |是|int(10) | 对应ID|
|account_type |是|char(1) | 平台账户、正常子账户、保证金子账户 |
|name |是|string（20） | 账户名称 |
|user_account|是|string（20） | 平台会员号|
|auth_mobile |是|string（11） | 授权手机 |
|items_type |否|string(60) |保证金类型 |
|items_id |否|int | 对应保证金类型的ID|
|section_id |否|string | 标段ID|
|op_user |是|int | 操作者|
保证金额账户：items_type, items_id 必填；
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
虚拟账户基本信息-见账户信息
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/index.md 0 → 100644
# desc
##1. 引言
### 1.1 文档目的
本文档旨在对终端与系统平台接口技术规范进行说明，用于指导开发人员进行相关业务的开发。
### 1.2 文档范围
描述移动端与服务器进行功能与数据交互时的全部接口协议。
##2. 接口协议
###2.1 基本约束
1. 接口数据使用UTF-8编码。
2. 接口地址的形式为 服务域名:端口/地址。
3. 接口地址请求时，使用HTTP POST, GET 方式。
4. 在请求头接口时放置在HTTP Header的Cookie部分 。返回值使用 JSON 数据格式。
6. 每个请求都需要加参数请求签名 sign, 见[签名规则](#sign_type)
7. 开发环境:
8. 正式环境:
9. 接口所有时间段和日期端均采用前闭后开的业务
###2.2 常量
名称 | 值 | 说明 |
-----|------|----|
app_id|1|接口编号
app_secret|123456789|对应接口秘钥
备注：具体合作编码和秘钥，另行通知
###2.3 HTTP 返回状态
stateCode | 含义 |返回内容|
-----|--------|---
200 |数据请正常返回 | 正常数据，见各接口格式
301 |业务错误| <a href="#error_301">错误代码</a>
401 |未授权| <a href="#error_401">错误代码</a>
404 |方法不存在| <a href="#error_404">错误代码</a>
409 |冲突请求|错误代码
421 |会话超时| <a href="#error_421">错误代码</a>
422 |表验证错误|<a href="#error_422">错误代码</a>
500 |服务器错误，确认状态并报告问题|<a href="#error_500">错误代码</a>
<a name="error_301" ></a>
301:
{
"message":"错误内容",
"status_code":301
}
<a name="error_500" ></a>
500:
{
"message":"Undefined variable:users",
"status_code":500
}
<a name="error_401" ></a>
401：
{
"message":"Failed to authenticate because of bad credentials or an invalid authorization header.",
"status_code":401
}
<a name="error_403" ></a>
403：
{
"message":"Failed to authenticate because of bad credentials or an invalid authorization header.",
"status_code":403
}
<a name="error_422" ></a>
422
{
"message": "Could not create new user.",
"status_code": 422,
"errors": {
"username": [
"The username field is required."
],
"password": [
"The password field is required."
]
}
}
### 签名方式：
<a name="sign_type"></a>
加密签名规则：MD5
```
如免登签名为：
md5(app_id=1&biz_content={"mobile":"13333333333"}&datetime=2017-04-11 12:00:00&app_secret=1234567);
```
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|app_id |是|string |接口id：花样菜场另行提供|
|app_secret |是|string |接口秘钥：花样菜场另行提供 |
|biz_content|是|string |具体业务参数 json 字符串|
|datetime|是|datetime|格式为: 2017-04-11 12:00:00, 生成请求时间，|
**备注**
1：注意加密顺序:app_secret,拼接在加密传最后，其他按KEY顺序排列。
2：加密后 sign 全小写
3：注意datetime 时间，目前定义签名有效期为5分钟。
##3 接口
docs/apis/trades/tradesCheckCode.md 0 → 100644
##tradesCheckCode
**简要描述：**
13、交易验证
交易号+验证码：
验证成功后，在进行扣款；
**请求URL：**
- ` /api/trades/checkcode`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|trans_no |是|string（10） |业务交易号|
|code |是|string（10） |验证码|
|op_user |是|int | 操作者|
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/trades/tradesPay.md 0 → 100644
##tradesPay
**简要描述：**
会员账户：
-》平台账户：会员费，手续费
-》会员账户：账期交易打款
-》保证金账户：缴纳保证金
-》实体卡：提现（白名单验证）, 转账（转给别人的实体卡：缴纳标书费）
平台账户：
-》会员账户：平台活动（返现）
-》实体卡：提现（白名单验证）, 转账（转给指定其他实体账户）
-》平台账户：A->B （平台资金补充）
保证账户：
-》会员账户：退款
-》实体账户：退款 / 扣款（扣款到发标人实体卡）
-》平台账户：扣款
**请求URL：**
- ` /api/trades/pay`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|business_sn |是|string（10） |业务交易号|
|business_id |是|string（10） |业务交易ID|
|business_type |是|string（10） |业务交易类型|
|account_no |是|string(60) |出金账户 |
|amount |是|int |出金金额 |
|bank_no |否|string |入金行号|
|bank_Name |否|string |入金行名|
|bank_Account_no |否|string |入金户号|
|bank_Account_name |否|string |入金户名|
|op_user |是|int | 操作者|
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
docs/apis/trades/tradesRefund.md 0 → 100644
##tradesRefund
**简要描述：**
12、交易退款
**请求URL：**
- ` /api/trades/refund`
**请求方式：**
- POST
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|orgins_no |是|string（10） |源交易号|
|business_sn |是|string（10） |业务交易号|
|business_id |是|string（10） |业务交易ID|
|business_type |是|string（10） |业务交易类型|
|account_no |否|string(60) |出金账户 |
|amount |否|string |退款金额 |
|bank_no |否|string |入金行号|
|bank_Name |否|string |入金行名|
|bank_Account_no |否|string |入金户号|
|bank_Account_name |否|string |入金户名|
|op_user |是|int | 操作者|
**返回示例**
```
{
'status_code':'200',
'message':'操作成功',
'data':
{
}
}
```
**返回参数说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|status_code|是|int |状态码|
|message|是|string |提示消息|
|data|是|obj | 业务数据 |
**备注**
- 更多返回错误代码请看首页的错误代码描述
***************
mkdocs.yml 0 → 100644
site_name: My Docs
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment