Report ADMIN API WIKI 文档
video Project Platform API WIKI
知识付费平台服务的API文档
接口调试
可以使用接口中提供的Curl命令进行调试,推荐安装jq来进行Json的序列化显示。
安装方式
Mac os
brew install jq
Windos
官网下载: https://stedolan.github.io/jq/
接口参数格式
目前接口部分使用 HTTP 的 Body 来进行参数传递,接口支持 application/json 的 Body 格式
同时也支持 application/x-www-form-urlencoded 的 Body 格式
两种方式均需要在 Header 中注明内容类型的属性。
请勿使用from-data传递Payload
接口返回说明
第一层 http code返回码,目前常见返回码如下
Http code | 说明 |
---|---|
200 | 调用成功 |
400 | 调用失败,返回自定义错误 |
401 | 鉴权失败 |
403 | 权限不足,没有调用权限 |
500 | 服务器本身出错 |
第二层 接口返回内容中的status和error字段
对于status,我们有如下规定
- status 是一个自然数
- status = 0表示接口调用成功
- status => 0 表示接口调用失败,这一部分错误号是每个接口独立的,同一个错误码在不用接口中会表示不一样的错误,具体错误说明在接口中会说明
错误说明
- 请求体错误,如请求体格式不对此错误一般伴随http 400 返回码
- 请求体错误,如缺少必要的请求参数、参数不合法,此错误一般伴随http 400 返回码
- 所请求的接口对于所携带的token其所属用户来说权限不足,此错误一般伴随http 403 返回码
- 所请求的接口使用了权限控制,但未在系统中登记权限路由名称,此错误一般伴随http 403 返回码
- 所请求的接口使用了权限控制,但未在系统中登记权限路由所属角色关联,此错误一般伴随http 403 返回码
error(针对于APP端)
为字符串,会给出status的具体错误原因描述,可信赖字段,可直接展示至前端页面
errors (针对于PC端 用于表单验证)
为一个对象,会给出status的具体错误原因描述,这个字段适用于程序开发中的错误调试,不应该把他的返回内容作为代码逻辑判断的条件。也不应直接在前端页面显示。
示例
{
"status": 1,
"errors": {
"account": " account 不能为空",
"code": " code 不能为空"
}
}
接口地址说明
http | https | |
---|---|---|
线下 | 47.119.124.57:8681 | |
预发布 | ||
正式 | 暂无 |
鉴权
接口使用的是基于 rfc6750 的Bearer Token 基于JWT来进行鉴权
我们的Bearer Token 使用的是,在实际业务中并不需要每次调用接口前都去获取Token。
在Token的有效期内可以直接用现有的Token进行接口调用,目前我们的Token 有效期为24小时,过期后则立即失效。此外客户端也可以对Token进行自解,来判断token有效期
访问需要鉴权的接口共需要两步:
- 判断当前Token是否存在或过期,若有异常则重新通过登录授权接口获取Token 。(通过账号密码进行验证,移动端额外需要设备唯一标识传至头部信息)
- 在Http Header中携带已保存的Token。
- 头部信息描述 key为Authorization value为登陆接口返回的Token。
系统鉴权 access
获取Bearer Token
GET_BEARER_TOKEN
获取系统中所使用的
token
curl --request POST \
--url '${API_HOST}/api/access/token' \
--header 'Content-Type: application/json' \
--data-raw '{"account":"13333891144","password":"123456"}' | jq
{
"status": 0,
"data": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImFjcC1hcGkifQ.eyJjb2RlIjoiM2MwZTMyYTciLCJkZXZpY2UiOiI0NSIsImF1ZCI6MzAzLCJpc3MiOiJhY3AtYXBpLWRldmVsb3BtZW50Iiwic3ViIjoiYWNwX21vYmlsZV91c2VyIiwiaWRlbnQiOiIyMGM2MDRiZCIsImlhdCI6MTY1NTk3ODQ5MywiZXhwIjoxNjU2MDY0ODkzfQ.SOXPoyApPWgmQGEkHBiXEjrjkS0FJ4zJxCFTU2Cpiuw",
"token_method": "HS256",
"token_type": "Bearer",
"expire_time": 1656064893,
"nickname": "zhusj"
}
}
HTTP Method
POST
HTTP Request
/api/access/token
Request Parameters Body
{
"account":"13333891144",
"password":"123456"
}
Title | Description | Type | Tips |
---|---|---|---|
account | 账号 | String | 账号默认 admin |
password | 密码 | String | 默认123456 |
Request Parameters Query
无
Response Data
Title | Type | Description | Tips |
---|---|---|---|
status | int | 状态 0 正常 1为失败 | |
token | string | token 字符串 |
|
token_method | string | 加密方式 | |
token_type | string | token 的类型,目前应该固定为 Bearer |
|
expire_time | int | 过期时间 | |
nickname | string | 后台账户昵称 |
将Token的中段Base64Decode后,可以序列化为一个Payload对象'
Token Payload:
{
"aud": 13, //用户ID
"iss":"acp-api-{环境变量}", //当前环境
"sub":"acp-mobile-user", //颁发方
"iat":1573116338, //颁发时间
"exp":1573119938 //过期时间
}
Payload
Title | Description | Type | Tips |
---|---|---|---|
aud | string | 使用管理员ID | |
iss | string | 颁发方 | |
sub | int | 使用方 | |
iat | int | 颁发时间 | |
exp | int | 过期时间 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
图文报告 report
图文报告列表
PAYMENT_REPORT_LIST
示例: 获取标题为《测试》并且在6月16日到6月22日之间的图文报告列表数据
curl --request GET \
--url "${API_HOST}/api/report?title=测试&start_ctime=2022-06-16&end_ctime=2022-06-22" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"data": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 1,
"data": [
{
"id": 1,
"cover": "http://static.ijiwei.com/20210108%3Aeep-h5-title.png",
"title": "2022全球半导体产业集微分析报告",
"price": 100,
"status": 2,
"subscribe_count": 0,
"publish_at": "2022-06-30 08:00:00"
}
]
}
}
HTTP Method
GET
HTTP Request
/api/report
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
title | 报告名称 | String | 否 | 报告名称 |
type_id | 分类ID | Int | 否 | 分类ID(预留) |
start_ctime | 上架时间-开始时间 | String | 否 | |
end_ctime | 上架时间-结束时间 | String | 否 | |
status | 上架状态 | Int | 否 | 0-待上架 1-上架 2-下架 |
end_ctime | 上架时间-结束时间 | String | 否 | |
page | 页数 | Int | 否 | 页数 |
limit | 条数 | Int | 否 | 条数,默认20 |
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
current_page | 当前页 | Int | |
last_page | 最后页 | Int | |
per_page | 每页条数 | Int | |
total | 总数 | Int | |
data | 数据 | Object:Array |
Title | Description | Type | Tips |
---|---|---|---|
id | report_id ID |
Int | 图文报告ID |
cover | 封面图 | Int | |
title | 报告信息 | Int | |
price | 报告价格 | Float|Int | |
subscribe_count | 订阅量 | Int | |
status | 状态 | Int | 0-待上架 1-上架 2-下架 |
publish_at | 上架时间 | String | |
type_name | 类目名称(预留) | String |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
新增图文报告
PAYMENT_REPORT_ADD
示例: 新增图文报告数据
curl --request POST \
--url '${API_HOST}/api/report' \
--header "Authorization: Bearer ${JWT_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{"title":"测试数据1","cover":"15421639996676.jpeg","type_id":1,"intro":"简介","directory":"目录介绍","file":{"file_name":"test","src":"static/test.pdf","format":"pdf","size":1000},"price":100,"read_count":300,"status":1,"publish_time":"2022-06-22 08:00:00","white_list":[{"given_user":"朱思嘉","given_position":"18434910083","given_company":"爱集微","read_count":100},{"given_user":"史蒂夫","given_position":"18434910085","given_company":"爱集微","read_count":100}]}' | jq
{
"status": 0,
"date":{
"id": 1
}
}
HTTP Method
POST
HTTP Request
/api/report
Request Parameters Body
{
"title": "测试数据1",
"cover": "15421639996676.jpeg",
"type_id": 1,
"intro": "简介",
"directory": "目录介绍",
"file": {
"file_name":"test",
"src":"static/test.pdf",
"format":"pdf",
"size":1000
},
"price":100,
"read_count":300,
"status":1,
"publish_time":"2022-06-22 08:00:00",
"short_intro": "购买须知",
"white_list": [
{
"given_user":"朱思嘉",
"given_position":"php",
"given_company":"爱集微",
"mobile":"18434819900",
"read_count":100,
"state":0
},
{
"given_user":"史蒂夫",
"given_position":"php",
"given_company":"爱集微",
"mobile":"18434819900",
"read_count":100,
"state":0
}
]
}
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
title | 报告名称 | String | 是 | 报告名称 |
cover | 封面地址 | String | 是 | 封面地址 |
type_id | 分类ID | String | 否 | 分类ID(预留) |
intro | 简介 | String | 是 | 简介 |
directory | 目录 | String | 是 | 目录 |
file | 文件信息 | Object | 是 | 上传附件信息 |
price | 报告价格 | String | 是 | 报告价格 |
read_count | 阅读次数 | Int | 是 | 阅读次数 |
status | 上架状态 | Int | 是 | 0-待上架 1-上架 2-下架 |
publish_time | 上架时间 | Sting | 否 | 立即上架为当前时间、定时上架为输入时间、暂不上架可不传此值 |
short_intro | 购买须知 | String | 否 | 购买须知 |
white_list | 白名单信息 | Object:list | 否 | 白名单信息 |
file
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
file_name | 文件名称 | String | 是 | 文件名称 |
src | 文件地址 | String | 是 | 文件地址 |
format | 文件类型 | String | 是 | 文件类型 |
size | 文件大小 | Int | 是 | 文件大小 |
white_list
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
given_user | 昵称 | String | 否 | 昵称 |
given_position | 职位 | String | 否 | 职位 |
given_company | 公司 | String | 否 | 公司 |
mobile | 电话 | String | 是 | 电话 |
read_count | 阅读次数 | Int | 是 | 阅读次数 |
state | 状态 | Int | 否 | 0-启动状态 1-禁用状态 不传则默认为0 |
Request Parameters Query
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
id | report_id ID |
Int | 图文报告ID |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
图文报告详情
PAYMENT_REPORT_INFO
示例: 获取ID为1的图文报告详情
curl --request GET \
--url "${API_HOST}/api/report/1" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"data": {
"id": 1,
"title": "测试数据1",
"cover": "http://s.laoyaoba.com/15421639996676.jpeg",
"type_id": 1,
"intro": "简介",
"directory": "目录介绍",
"file_address": "http://s.laoyaoba.com/15421639996676.pdf",
"price":100,
"read_count":300,
"status":1,
"publish_time":"2022-06-22 08:00:00",
"short_intro":"购买须知"
}
}
HTTP Method
GET
HTTP Request
/api/report/{report_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
id | report_id ID |
Int | 图文报告ID |
title | 报告名称 | String | 报告名称 |
cover | 封面地址 | String | 封面地址 |
type_id | 分类ID | String | 分类ID(预留) |
intro | 简介 | String | 简介 |
directory | 目录 | String | 目录 |
file_address | 文件地址 | String | 文件地址 |
price | 报告价格 | String | 报告价格 |
read_count | 阅读次数 | Int | 阅读次数 |
status | 上架状态 | Int | 0-待上架 1-上架 2-下架 |
publish_time | 上架时间 | Sting | 立即上架为当前时间、定时上架为输入时间、暂不上架可不传此值 |
short_intro | 购买须知 | Sting | 立即上架为当前时间、定时上架为输入时间、暂不上架可不传此值 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
修改图文报告
PAYMENT_REPORT_MODIFY
示例: 修改id为1图文报告的售卖信息与白名单信息
curl --request PUT \
-- url '${API_HOST}/api/report/1' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer ${JWT_TOKEN}" \
--data-raw '{"price":100,"read_count":300,"status":1,"publish_time":"2022-06-22 08:00:00","white_list":[{"given_user":"朱思嘉","given_position":"php","given_company":"爱集微","residue_count":100,"state":0},{"given_user":"史蒂夫","given_position":"php","given_company":"爱集微","residue_count":100,"state":0}]}'
{
"status": 0,
"date":{
"id": 1
}
}
HTTP Method
PUT
HTTP Request
/api/report/{report_id}
Request Parameters Query
无
Request Parameters Body
{
"price":100,
"read_count":300,
"status":1,
"publish_time":"2022-06-22 08:00:00",
"short_intro":"购买须知"
}
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
price | 报告价格 | String | 否 | 报告价格 |
read_count | 阅读次数 | Int | 否 | 阅读次数 |
status | 上架状态 | Int | 否 | 1-上架 2-下架 |
publish_time | 上架时间 | Sting | 否 | 立即上架为当前时间、定时上架为输入时间、暂不上架可不传此值 |
short_intro | 购买须知 | Sting | 否 | 购买须知 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
id | report_id ID |
Int | 图文报告ID |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
删除图文报告
PAYMENT_REPORT_DELETE
删除id为1的图文报告
curl --request DELETE \
--url "${API_HOST}/api/report/{report_id}" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"date":{
"id": 1
}
}
HTTP Method
DELETE
HTTP Request
/api/report/{report_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
id | report_id ID |
Int | 图文报告ID |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
白名单列表
REPORT_WHITE_LIST
查找电话、昵称、企业名、最近修改人为test的图文报告状态 条件为或 or
curl --request GET \
--url "${API_HOST}/api/report/1/white?search=test" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"date": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 1,
"data": [{
"id": 1,
"given_user": "朱思嘉",
"given_position": "php",
"given_company": "爱集微",
"mobile": "18343819907",
"read_count": 200,
"residue_count": 100,
"last_modify_author": "朱思嘉",
"updated_at": "2020-07-23 9:00:00",
"state": 0
},
{
"id": 2,
"given_user": "史蒂夫",
"given_position": "php",
"given_company": "爱集微",
"mobile": "18343819907",
"read_count": 200,
"residue_count": 0,
"last_modify_author": "朱思嘉",
"updated_at": "2020-07-23 9:00:00",
"state": 0
}
]
}
}
HTTP Method
GET
HTTP Request
/api/report/{report_id}/white
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
search | 搜索信息 | String | 否 | 搜索信息 |
page | 页数 | Int | 否 | 页数 |
limit | 条数 | Int | 否 | 条数,默认20 |
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
current_page | 当前页 | Int | |
last_page | 最后页 | Int | |
per_page | 每页条数 | Int | |
total | 总数 | Int | |
data | 数据 | Object:Array |
Title | Description | Type | Tips | |
---|---|---|---|---|
id | white_list_id ID |
String | 白名单ID | |
given_user | 昵称 | String | 昵称 | |
given_position | 职位 | String | 职位 | |
given_company | 公司 | String | 公司 | |
mobile | 电话 | String | 电话 | |
read_count | 阅读次数 | Int | 阅读次数 | |
residue_count | 剩余次数 | Int | 剩余次数 | |
last_modify_author | 修改人 | String | 修改人 | |
updated_at | 剩余次数 | String | 修改时间 | |
state | 状态 | Int | 0-启动状态 1-禁用状态 |
白名单添加
REPORT_WHITE_ADD
示例: 添加report_id为1图文报告白名单信息
curl --request POST \
-- url '${API_HOST}/api/report/1/white' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer ${JWT_TOKEN}" \
--data-raw '{"given_user":"朱思嘉","given_position":"php","given_company":"爱集微","read_count":100,"mobile":"18434819907"}'
{
"status": 0,
"date":{
"id": 1
}
}
HTTP Method
POST
HTTP Request
/api/report/{report_id}/white
Request Parameters Query
无
Request Parameters Body
{
"given_user": "朱思嘉",
"given_position": "php",
"given_company": "爱集微",
"read_count": 100,
"mobile": "18434819907"
}
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
given_user | 昵称 | String | 否 | 昵称 |
given_position | 职位 | String | 否 | 职位 |
given_company | 公司 | String | 否 | 公司 |
read_count | 阅读次数 | Int | 是 | 总次数 |
mobile | 电话 | Int | 是 | 电话 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
id | white_list_id ID |
Int | 白名单ID |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
白名单详情
REPORT_WHITE_INFO
示例: 获取report_id为37white_list_id为36的白名单用户信息
curl --request Get \
-- url '${API_HOST}/api/report/37/white/36' \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"data": {
"id": 1,
"given_user": "朱思嘉",
"given_position": "php",
"given_company": "爱集微",
"mobile": "18434819907",
"read_count": 0,
"residue_count": 0,
"state": 0
}
}
HTTP Method
Get
HTTP Request
/api/report/{report_id}/white/{white_list_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
id | white_list_id ID |
String | 白名单ID |
given_user | 昵称 | String | 昵称 |
given_position | 职位 | String | 职位 |
given_company | 公司 | String | 公司 |
mobile | 电话 | String | 电话 |
read_count | 阅读次数 | Int | 阅读次数 |
residue_count | 剩余次数 | Int | 剩余次数 |
state | 状态 | Int | 0-启动状态 1-禁用状态 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
修改白名单
REPORT_WHITE_EDIT
示例: 修改report_id为1图文报告并且white_list_id为1白名单信息
curl --request PUT \
-- url '${API_HOST}/api/report/1/white/1' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer ${JWT_TOKEN}" \
--data-raw '{"given_user":"朱思嘉","given_position":"php","given_company":"爱集微","residue_count":100,"state":0}'
{
"status": 0,
"date":{
"id": 1
}
}
HTTP Method
PUT
HTTP Request
/api/report/{report_id}/white/{white_list_id}
Request Parameters Query
无
Request Parameters Body
{
"given_user": "朱思嘉",
"given_position": "php",
"given_company": "爱集微",
"residue_count": 100,
"state": 0
}
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
given_user | 昵称 | String | 否 | 昵称 |
given_position | 职位 | String | 否 | 职位 |
given_company | 公司 | String | 否 | 公司 |
residue_count | 剩余次数 | Int | 否 | 剩余次数 |
state | 状态 | Int | 否 | 0-启动状态 1-禁用状态 不传则默认为0 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
id | white_list_id ID |
Int | 白名单ID |
白名单数据导入
REPORT_WHITE_IMPORT
导入白名单excel表格数据
curl --request POST \
--url "${API_HOST}/api/report/1/excel" \
--header "Authorization: Bearer ${JWT_TOKEN}" \
--form 'file=@"./示例表.xlsx"' | jq
{
"status": 0,
"date":{
"total": 100,
"success": 50,
"repeat": 50,
"error": 0
}
}
HTTP Method
POST
HTTP Header
multipart/form-data
HTTP Request
/api/report/{report_id}/excel
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
file | 文件对象 | Object:file | 是 | 文件对象 |
Response Data
Title | Description | Type | Tips | |
---|---|---|---|---|
total | 总数 | Int | 导入总数 | |
success | 成功数量 | Int | 成功数量 | |
repeat | 重复数量 | Int | 重复数量 | |
error | 失败数量 | Int | 失败数量 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
白名单数据导出
REPORT_WHITE_EXPORT
根据传入ID导出白名单excel表格数据
curl --request GET \
--url "${API_HOST}/api/report/1/excel?id=[100,101,102]' \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
HTTP Method
GET
HTTP Request
/api/report/{report_id}/excel
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
id | ID | Object:Array | 否 | white_list_id ID 不传入则导出所有属于该报告的白名单列表信息 |
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
file | 文件对象 | Object:file | 文件对象 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
图文报告用户数据
GET_REPORT_CUSTOMER
示例: 获取ID为1的图文报告用户数据
curl --request GET \
--url "${API_HOST}/api/report/1/customer" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"date": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 1,
"data": [{
"user_id": 231232,
"nick_name": "王强",
"avatar": "http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile": "133422898123",
"occurred_count": 50,
"residue_count": 100,
"last_payment_at": 1323892332,
"last_login_at": 12312321908,
"last_review_at": 12312321908,
"regist_at": 1323892332
},
{
"user_id": 231233,
"nick_name": "李刚",
"avatar": "http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile": "133422892109",
"occurred_count": 100,
"residue_count": 200,
"last_payment_at": 1323892332,
"last_login_at": 12312321908,
"last_review_at": 12312321908,
"regist_at": 1323892332
}
]
}
}
HTTP Method
GET
HTTP Request
/api/report/{report_id}/customer
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
page | 页数 | Int | 否 | 页数 |
limit | 条数 | Int | 否 | 条数,默认20 |
Request Parameters Body
暂无
Response Data
date Object
Title | Description | Type | Tips |
---|---|---|---|
current_page | 当前页 | Int | |
last_page | 最后页 | Int | |
per_page | 每页条数 | Int | |
total | 总数 | Int | |
data | 数据 | Object:Array |
Title | Description | Type | Tips |
---|---|---|---|
date | 用户信息 | Array |
date Object
Title | Description | Type | Tips |
---|---|---|---|
user_id | 用户ID | Int | |
avatar | 头像 | String | |
nick_name | 昵称 | String | |
mobile | 手机号 | String | |
occurred_count | 已使用次数 | Int | 已使用次数 |
residue_count | 剩余次数 | Int | 剩余次数 |
last_payment_at | 最后订阅时间 | Int | 白名单也会产生订阅时间 |
last_login_at | 最后登录时间 | Int | |
last_review_at | 最后浏览时间 | Int | |
regist_at | 注册时间 | Int |
通过报告名获取带下载凭证的url
GET_REPORT_DOWNLOADURL
示例: 获取report_name为02_SHELL编程之变量定义.pdf的图文报告url
HTTP Method
GET
HTTP Request
/api/report/downloadurl
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
report_name | 报告名称 | string | 是 | 报告名称:*.pdf |
Request Parameters Body
暂无
Response Data
{
"status": 0,
"data": "https://privte.laoyaoba.com/uploads/02_SHELL编程之变量定义.pdf?e=1686924541&token=99vFAJy1wVeXiJdSV2BB-VHqOhgKrdRZydXfUv58:kM-pmz7QUgIK13N7yInyfXU4RL8="
}
Title | Description | Type | Tips |
---|---|---|---|
data | 带下载凭证的url | string |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
系统基础设施 tool
白名单示例文件
WHITE_LIST_EXAMPLE
下载白名单excel示例表格数据
curl --request GET \
--url "${API_HOST}/api/white/example' \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
HTTP Method
GET
HTTP Request
/api/white/example
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Explain | |
---|---|---|---|---|
file | 文件对象 | Object:file | 文件对象 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
白名单文件数据转换
WHITE_EXPORT_CONVERT
白名单文件数据转换
curl --request POST \
--url "${API_HOST}/api/white/example' \
--header "Authorization: Bearer ${JWT_TOKEN}" \
--form "file=@"/Users/zhusijia/Downloads/公司-record/抽奖人员示例表.xlsx" | jq
{
"status": 0,
"data": [
{
"given_user": "朱思嘉1",
"given_position": "php1",
"given_company": "爱集微1",
"mobile": 1,
"read_count": 100
},
{
"given_user": "朱思嘉2",
"given_position": "php2",
"given_company": "爱集微2",
"mobile": 2,
"read_count": 101
}
]
}
HTTP Method
POST
HTTP Header
multipart/form-data
HTTP Request
/api/white/example
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
file | 文件对象 | Object:file | 是 | 文件对象 |
Response Data
Title | Description | Type | Explain | |
---|---|---|---|---|
given_user | 昵称 | String | 昵称 | |
given_position | 职位 | String | 职位 | |
given_company | 公司 | String | 公司 | |
mobile | 电话 | String | 电话 | |
read_count | 阅读次数 | Int | 阅读次数 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/07/05 | 朱思嘉 | 新增 |
获取七牛token
GET_QINIU_TOKEN
获取七牛云TOKEN
curl --request GET \
--url "${API_HOST}/api/qiniu/token' | jq
{
"status": 0,
"qiniu_token": "99vFAJy1wVeXiJdSV2BB-VHqOhgKrdRZydXfUv58:EB38gPLhyCYExdrLZyC7q3mc25k=:eyJzY29wZSI6Imppd2VpLW1hcmtldCIsImRlYWRsaW5lIjoxNjU0NzY5MzU4fQ=="
}
HTTP Method
GET
HTTP Request
/api/qiniu/token
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
type | token类型 | string | 是 | default: 公共的仓库,private :私有的仓库 |
Request Parameters Body
无
Response Data
Title | Description | Type | Explain | |
---|---|---|---|---|
qiniu_token | 七牛云token | String |
复制七牛文件到私有仓库接口
GET_QINIU_TOKEN
复制七牛文件到私有仓库接口
{
"status": 0,
"data" : {
"message": "File copied successfully"
}
}
HTTP Method
GET
HTTP Request
/api/qiniu/copyfile
Request Parameters Query
Request Parameters Body
无
Response Data
Title | Description | Type | Explain | |
---|---|---|---|---|
message | 复制结果成功提示 | String |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 朱思嘉 | 新增 |
文档使用帮助
在index.html.md
文件中进行编辑目录和文档总体结构,然后在includes目录中添加对应的模块。
文档使用Markdown语言排版。
Markdown格式示例
# 标题
## 二级标题
### .......
``` json
代码块
```
表格
表头 | 表头
---------- | -------
内容 | 内容
内容 | 内容
`Something`
表格
表头 | 表头 |
---|---|
内容 | 内容 |
内容 | 内容 |
无序列表
无序列表
Json
是没有注释的 避免在json中写注释
Something
高亮
加粗 粗体
横线
下划线
斜体
图片
知识付费消费者
获取所有消费者的列表
Payment_Customer_List
示例: 获取在6月16日到6月22日之间产生过订阅行为的订单用户
curl --request GET \
--url "${API_HOST}/api/customer?start_date=2022-06-16&end_date=2022-06-22" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"date": [
{
"user_id": 231232,
"nick_name": "王强",
"avatar": "http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile": "133422898123",
"payment_time": 3,
"payment_total": "1200000",
"last_payment_at": 1323892332,
"last_login_at": 12312321908,
"last_review_at": 12312321908,
"regist_at": 1323892332
},
{
"user_id": 231233,
"nick_name": "李刚",
"avatar": "http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile": "133422892109",
"payment_time": 1,
"payment_total": "0",
"last_payment_at": 1323892332,
"last_login_at": 12312321908,
"last_review_at": 12312321908,
"regist_at": 1323892332
}
]
}
HTTP Method
GET
HTTP Request
/api/customer
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
type | 1:订单用户 2:白名单用户 | Int | 否 | 默认为1,默认查询全部订单用户 |
start_date | 起始时间 | String | 是 | |
end_date | 结束时间 | String | 否 | 如果不提供结束时间,则结束时间为当天 |
mobile | 手机号 | String | 否 | 全匹配 |
Request Parameters Body
暂无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
date | 用户信息 | Array |
date Object
Title | Description | Type | Tips |
---|---|---|---|
user_id | 用户ID | Int | |
avatar | 头像 | String | |
nick_name | 昵称 | String | |
mobile | 手机号 | String | |
payment_count | 订阅的次数 | Int | 白名单也会产生订阅次数 |
payment_total | 总付费金额 | String | 单位为分 |
last_payment_at | 最后订阅时间 | Int | 白名单也会产生订阅时间 |
last_login_at | 最后登录时间 | Int | |
last_review_at | 最后浏览时间 | Int | |
regist_at | 注册时间 | Int |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 谢宇轩 | 新增 |
获取某一个消费者的全部订单数据
Payment_Customer_Info
示例: 获取用户ID为612381的消费者订阅信息和订单信息
curl --request GET \
--url "${API_HOST}/api/customer/612381/order?limit=15&page=1" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"current_page": 1,
"last_page": 1,
"total": 1,
"date": [
{
"id": 1,
"number": "423132323232372212",
"order_title": "概念股投资报告第1期",
"total": "300000",
"size": 1,
"state": 3,
"checkout_at": 1323892332,
"expire_at": 1323910332,
"paid_at": 1982719021,
"fulfilled_at": 1982719021,
"trade_info": {
"third_trade_num": "",
"third_trade_identity": "",
"payment_source": 1,
"payment_channel": 2
},
"order_item": {
"id": 2,
"title": "2022全球半导体产业集微分析报告(修订版)",
"cover": "http://s.laoyaoba.com/jwImg/cover/2wqweasd.jpg",
"price": "600000"
},
"customer_info": {
"id": 22342342,
"nick_name": "李刚",
"avatar": "http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile": "133422892109"
},
"order_item_usage": {
"quantity_count":100,
"available_count": 0,
"expend_status": 0
}
}
]
}
HTTP Method
GET
HTTP Request
/api/customer/{customer_id}/order
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
limit | 每页数量 | Int | 否 | default:10 |
page | 页码 | Int | 否 | default:1 |
Request Parameters Body
暂无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
date | 订单列表数据 | Array | |
current_page | 当前页面页码 | Int | |
last_page | 最后一页页码 | Int | |
total | 总数 | Int |
date Object
Title | Description | Type | Tips |
---|---|---|---|
id | 订单ID | Int | |
number | 订单编号 | String | |
state | 订单状态 | Int | |
order_title | 订单标题 | String | |
total | 订单购买总价 | String | |
size | 购买数量 | Int | |
Paid_at | 支付时间 | Int | |
fulfilled_at | 完成时间 | Int | |
expire_at | 支付过期时间 | Int | |
checkout_at | 下单时间 | Int | |
order_item | 下单商品 | Report Object |
|
trade_info | 支付信息 | Trade Object |
|
customer_info | 消费者信息 | Customer Object |
|
order_item_usage | 订单内容使用信息 | Usage Object |
订单状态 order.state
state | Description | Tips |
---|---|---|
0 | 全部订单 | 为默认值 |
1 | 待付款订单 | |
2 | 已取消订单 | 包含取消支付或支付超时 |
3 | 已完成订单 | 已付款成功,会转为已完成 |
Report
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
id | 报告ID | Int | |
title | 报告标题 | String | |
cover | 封面 | String | |
price | 价格 | String |
Trade
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
third_trade_num | 第三方支付流水单号 | String | 可以为空 |
third_trade_identity | 第三方支付用户标识 | String | 可以为空 |
payment_source | 下单支付来源 | Int | |
payment_channel | 支付渠道 | Int |
payment_source 支付来源
payment_source | Description | Tips |
---|---|---|
0 | 无 | 一般为免费订单 |
1 | IOS | |
2 | 安卓 | |
3 | PC | |
4 | 手机H5 | |
5 | 微信浏览器 | 此来源只能使用微信支付 |
payment_channel 支付渠道
payment_channel | Description | Tips |
---|---|---|
0 | 无支付渠道 | 无支付渠道一般为免费订单 |
1 | 微信 | |
2 | 支付宝 |
Customer
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
id | 用户ID | Int | |
nick_name | 昵称 | String | |
avatar | 头像 | String | |
mobile | 联系电话 | String |
Usage
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
quantity_count | 报告ID | Int | |
available_count | 报告标题 | String | |
expend_status | 使用消耗情况 | String | 1 : 获取已经使用完全部的阅读次数的订单 0 : 仍没有使用完阅读此书的订单 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/23 | 谢宇轩 | 新增 |
获取某一个消费者的行为统计
Payment_Customer_Total
示例: 获取用户ID为612381的消费者基础信息与行为统计
curl --request GET \
--url "${API_HOST}/api/customer/612381" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"data": {
"user_id": 5181743,
"nick_name": "N_183****6948",
"mobile": "18334786948",
"payment_count": 12,
"payment_total": 40206,
"last_payment_at": 1656749462,
"last_login_at": 1627623392,
"last_review_at": 0,
"regist_at": 1627639454
}
}
HTTP Method
GET
HTTP Request
/api/customer/{customer_id}
Request Parameters Query
暂无
Request Parameters Body
暂无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
date | 订单列表数据 | Object |
date Object
Title | Description | Type | Tips |
---|---|---|---|
user_id | 用户ID | Int | |
nick_name | 用户昵称 | String | |
mobile | 用户手机号 | String | |
payment_count | 下单数量 | Int | |
payment_total | 下单总金额 | Int | |
last_payment_at | 最近付款时间 | Int | |
last_login_at | 最后登陆时间 | Int | |
last_review_at | 最近查看时间 | Int | |
regist_at | 账户注册时间 | Int |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/07/05 | 朱思嘉 | 新增 |
知识付费报告订单
获取全部订单信息列表
Payment_Order_List
示例: 获取下单日期22年3月6日到今天为止全部的订单,
curl --request GET \
--url "${API_HOST}/api/order?limit=15&page=1&start_date=2022-03-06?state=1" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status": 0,
"current_page": 1,
"last_page": 1,
"total": 1,
"date": [
{
"id": 1,
"number": "423132323232372212",
"order_title": "概念股投资报告第1期",
"total": "300000",
"size": 1,
"state": 3,
"checkout_at": 1323892332,
"expire_at": 1323910332,
"paid_at": 1982719021,
"fulfilled_at": 1982719021,
"trade_info": {
"third_trade_num": "",
"third_trade_identity": "",
"payment_source": 1,
"payment_channel": 2
},
"order_item": {
"id": 2,
"title": "2022全球半导体产业集微分析报告(修订版)",
"cover": "http://s.laoyaoba.com/jwImg/cover/2wqweasd.jpg",
"price": "600000"
},
"customer_info": {
"id": 22342342,
"nick_name": "李刚",
"avatar": "http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile": "133422892109"
},
"order_item_usage": {
"quantity_count":100,
"available_count": 0,
"expend_status": 0
}
},
{
"id": 2,
"number": "42313232323231232",
"order_title": "2022全球半导体产业集微分析报告",
"total": "600000",
"size": 1,
"state": 1,
"checkout_at": 1323892332,
"expire_at": 1323910332,
"paid_at": 1982719021,
"fulfilled_at": 1982719021,
"trade_info": {
"third_trade_num": "123870sacsa0cxawdawd",
"third_trade_identity": "a2dc123asdsahdlhqkwjewa",
"payment_source": 2,
"payment_channel": 2
},
"order_item": {
"id": 2,
"title": "2022全球半导体产业集微分析报告(修订版)",
"cover": "http://s.laoyaoba.com/jwImg/cover/2wqweasd.jpg",
"price": "600000"
},
"customer_info": {
"id": 22342342,
"nick_name": "李刚",
"avatar": "http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile": "133422892109"
},
"order_item_usage": {
"quantity_count":100,
"available_count": 23,
"expend_status": 0
}
},
{
"id": 3,
"number": "423132323232310973",
"order_title": "概念股投资报告",
"total": "300000",
"size": 1,
"state": 1,
"checkout_at": 1323892332,
"expire_at": 1323910332,
"paid_at": 1982719021,
"fulfilled_at": 1982719021,
"trade_info": {
"third_trade_num": "123870sacsa0cxawdawd",
"third_trade_identity": "a2dc123asdsahdlhqkwjewa",
"payment_source": 4,
"payment_channel": 1
},
"order_item": {
"id": 2,
"title": "2022全球半导体产业集微分析报告(修订版)",
"cover": "http://s.laoyaoba.com/jwImg/cover/2wqweasd.jpg",
"price": "600000"
},
"customer_info": {
"id": 22342342,
"nick_name": "李刚",
"avatar": "http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile": "133422892109"
},
"order_item_usage": {
"quantity_count":100,
"available_count": 100,
"expend_status": 1
}
}
]
}
HTTP Method
GET
HTTP Request
/api/order
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
limit | 每页数量 | Int | 否 | default:10 |
page | 页码 | Int | 否 | default:1 |
start_date | 起始时间 | String | 是 | |
end_date | 结束时间 | String | 否 | 如果不提供结束时间,则结束时间为当天 |
state | 订单状态 | Int | 否 | 默认值为0,意为获取全部 |
usage_expend_status | 订单使用耗损程度 | Int | 否 | 默认值为0,意为获取全部。传1则获取已经使用完全部的阅读次数的订单,2为获取仍没有使用完阅读此书的订单 |
third_trade_num | 第三方支付流水号 | String | 否位 | 支付宝或微信外部订单流水号,可以模糊查询前6位。 |
number | 订单号 | String | 否 | 系统订单号,可以模糊查询前6位。 |
订单状态 query.state
state | Description | Tips |
---|---|---|
0 | 全部订单 | 为默认值 |
1 | 待付款订单 | |
2 | 已取消订单 | 包含取消支付或支付超时 |
3 | 已完成订单 | 已付款成功,会转为已完成 |
使用情况 query.usage_expend_status
usage_expend_status | Description | Tips |
---|---|---|
0 | 全部 | 无筛选状态为默认值 |
1 | 已耗尽 | 已经使用完全部的阅读次数的订单 |
2 | 使用中 | 没有使用完阅读次数的订单 |
Request Parameters Body
暂无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
date | 订单数据 | Order Object |
Order Object
Title | Description | Type | Tips |
---|---|---|---|
id | 订单ID | Int | |
number | 订单编号 | String | |
state | 订单状态 | Int | |
order_title | 订单标题 | String | |
total | 订单购买总价 | String | |
size | 购买数量 | Int | |
Paid_at | 支付时间 | Int | |
fulfilled_at | 完成时间 | Int | |
expire_at | 支付过期时间 | Int | |
checkout_at | 下单时间 | Int | |
order_item | 下单商品 | Report Object |
|
trade_info | 支付信息 | Trade Object |
|
customer_info | 消费者信息 | Customer Object |
|
order_item_usage | 订单内容使用信息 | Usage Object |
订单状态 order.state
state | Description | Tips |
---|---|---|
0 | 全部订单 | 为默认值 |
1 | 待付款订单 | |
2 | 已取消订单 | 包含取消支付或支付超时 |
3 | 已完成订单 | 已付款成功,会转为已完成 |
Report
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
id | 报告ID | Int | |
title | 报告标题 | String | |
cover | 封面 | String | |
price | 价格 | String |
Trade
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
third_trade_num | 第三方支付流水单号 | String | 可以为空 |
third_trade_identity | 第三方支付用户标识 | String | 可以为空 |
payment_source | 下单支付来源 | Int | |
payment_channel | 支付渠道 | Int |
payment_source
支付来源
payment_source | Description | Tips |
---|---|---|
1 | pc | |
2 | h5 | |
3 | wx_h5 | 此来源只能使用微信支付 |
4 | ios | |
5 | android |
payment_channel
支付渠道
payment_channel | Description | Tips |
---|---|---|
0 | 初始化订单 | 即待支付订单 |
1 | 免费 | |
2 | 微信 | |
3 | 支付宝 |
Customer
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
id | 用户ID | Int | |
nick_name | 昵称 | String | |
avatar | 头像 | String | |
mobile | 联系电话 | String |
Usage
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
quantity_count | 报告ID | Int | |
available_count | 报告标题 | String | |
expend_status | 使用消耗情况 | String | 1 : 获取已经使用完全部的阅读次数的订单 0 : 仍没有使用完阅读此书的订单 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/24 | 谢宇轩 |
获取订单详情和发票信息
Payment_Order_Info
示例: 获取423132323232372212订单的基础信息和发票信息。
curl --request GET \
--url "${API_HOST}/api/order/423132323232372212" \
--header "Authorization: Bearer ${JWT_TOKEN}" | jq
{
"status":0,
"current_page":1,
"last_page":1,
"total":1,
"date":{
"id":1,
"number":"423132323232372212",
"order_title":"概念股投资报告第1期",
"total":"300000",
"size":1,
"state":3,
"checkout_at":1323892332,
"expire_at":1323910332,
"paid_at":1982719021,
"fulfilled_at":1982719021,
"trade_info":{
"third_trade_num":"",
"third_trade_identity":"",
"payment_source":1,
"payment_channel":2
},
"order_item":{
"id":2,
"title":"2022全球半导体产业集微分析报告(修订版)",
"cover":"http://s.laoyaoba.com/jwImg/cover/2wqweasd.jpg",
"price":"600000"
},
"customer_info":{
"id":22342342,
"nick_name":"李刚",
"avatar":"http://s.laoyaoba.com/jwImg/img/1231287u8123.jpg",
"mobile":"133422892109"
},
"order_item_usage":{
"quantity_count":100,
"available_count":0,
"expend_status":0
},
"invoice_info":{
"state": 0,
"create_time": 1655706447,
"is_vat": 0,
"invoice_title": "爱集微咨询(厦门)有限公司",
"invoice_amount": 0.01,
"invoice_tax_num": "91350200MA2YC2UA52",
"vat_name": "小小",
"vat_mail_address": "954398065@qq.com",
"vat_company_name": "小小",
"vat_company_address": "",
"vat_company_mobile": "",
"vat_telphone": "13810875748",
"vat_bank_name": "",
"vat_bank_accoun": "",
"invoice_option": 2
}
}
}
HTTP Method
GET
HTTP Request
/api/order/{number}
Request Parameters Query
暂无
Request Parameters Body
暂无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
date | 订单列表数据 | Array | |
current_page | 当前页面页码 | Int | |
last_page | 最后一页页码 | Int | |
total | 总数 | Int |
date Object
Title | Description | Type | Tips |
---|---|---|---|
id | 订单ID | Int | |
number | 订单编号 | String | |
state | 订单状态 | Int | 订单状态 0-已下单 1-待支付 2-已取消 3-已完成 |
order_title | 订单标题 | String | |
total | 订单购买总价 | String | |
size | 购买数量 | Int | |
Paid_at | 支付时间 | Int | |
fulfilled_at | 完成时间 | Int | |
expire_at | 支付过期时间 | Int | |
checkout_at | 下单时间 | Int | |
order_item | 下单商品 | Report Object |
|
trade_info | 支付信息 | Trade Object |
|
customer_info | 消费者信息 | Customer Object |
|
order_item_usage | 订单内容使用信息 | Usage Object |
|
inovice_info | 开票信息 | Invoice Object |
为空时内部属性字符串时空,这里不会出现null |
订单状态 order.state
state | Description | Tips |
---|---|---|
0 | 全部订单 | 为默认值 |
1 | 待付款订单 | |
2 | 已取消订单 | 包含取消支付或支付超时 |
3 | 已完成订单 | 已付款成功,会转为已完成 |
Report
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
id | 报告ID | Int | |
title | 报告标题 | String | |
cover | 封面 | String | |
price | 价格 | String |
Trade
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
third_trade_num | 第三方支付流水单号 | String | 可以为空 |
third_trade_identity | 第三方支付用户标识 | String | 可以为空 |
payment_source | 下单支付来源 | Int | |
payment_channel | 支付渠道 | Int |
payment_source
支付来源
payment_source | Description | Tips |
---|---|---|
0 | 无 | 一般为免费订单 |
1 | IOS | |
2 | 安卓 | |
3 | PC | |
4 | 手机H5 | |
5 | 微信浏览器 | 此来源只能使用微信支付 |
payment_channel
支付渠道
payment_channel | Description | Tips |
---|---|---|
0 | 无支付渠道 | 无支付渠道一般为免费订单 |
1 | 微信 | |
2 | 支付宝 |
Customer
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
id | 用户ID | Int | |
nick_name | 昵称 | String | |
avatar | 头像 | String | |
mobile | 联系电话 | String |
Usage
下单付费报告信息
Title | Description | Type | Tips |
---|---|---|---|
quantity_count | 报告ID | Int | |
available_count | 报告标题 | String | |
expend_status | 使用消耗情况 | String | 1 : 获取已经使用完全部的阅读次数的订单 0 : 仍没有使用完阅读此书的订单 |
Invoice
开票信息
Title | Description | Type | Tips | attribute |
---|---|---|---|---|
status | 是否开票 | Int | 为0说明无发票信息,下方属性为空 | 个人、企业 |
create_time | 开票时间 | String | 个人、企业 | |
is_vat | 是否增值税发票 | Int | 是否增值税发票 0-否1-是 | 个人、企业 |
invoice_title | 发票类型 | Int | 发票抬头名称 | 个人、企业 |
invoice_amount | 金额 | Int | 金额 | 个人、企业 |
invoice_tax_num | 税号 | String | 税号 | 个人、企业 |
vat_name | 联系人 | String | 个人、企业 | |
vat_mail_address | 邮箱 | String | 个人、企业 | |
vat_company_name | 公司名称 | String | 企业 | |
vat_company_address | 公司地址 | String | 企业 | |
vat_company_mobile | 公司电话 | String | 企业 | |
vat_telphone | 联系电话 | String | 个人、企业 | |
vat_bank_name | 开户银行 | String | 企业 | |
vat_bank_accoun | 银行账户 | String | 企业 | |
invoice_option | 开户银行 | String | 抬头类型 1个人 2企业 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/06/24 | 谢宇轩 |