EDP API WIKI
企业服务管理后台API结构图
接口调用的参数格式
目前接口部分使用 HTTP 的 Body 来进行参数传递,接口支持 application/json 的 Body 格式
同时也支持 application/x-www-form-urlencoded 的 Body 格式
两种方式均需要在 Header 中注明内容类型的属性。
请勿使用from-data传递Payload
鉴权
参考应用管理平台通用的鉴权认证方式,使用OAuth授权,通过携带Jwt认证。
接口返回说明
第一层 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 | |
---|---|---|
线下 | http://120.79.71.191:18089 |
|
预发布 | ||
正式 | 待定 |
Customers API 客户
客户相关的API
CustomerSearch 客户信息检索
客户信息搜索
获取全部的合作中的客户列表信息
GET
: /api/customer?vaild=1--header 'Bearer: {token}'
HTTP Method
GET
HTTP Request
/api/customer
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
vaild | 是否到期 | integer | 否 | 1 意为有效期内,合作中,反之为0 |
until | 剩余时间 | integer | 否 | 剩余时间的单位为天,30可以理解为小于等于30天, 正整数 |
style | 客户类型 | enum | 否 | 见Style 的定义 |
sale | 负责销售 | string | 否 | |
search | 客户名称 | string | 否 | 模糊匹配 |
limit | 显示个数 | string | 否 | 最大不超过100,默认20 |
page | 分页页数 | string | 否 |
Style.Schema
Value | Label | Tips |
---|---|---|
company | 公司客户 | |
park | 园区客户 |
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
current_page | 当前页数 | integer | 是 | |
last_page | 最后一页的页码 | integer | 是 | |
per_page | 每页显示的个数 | integer | 是 | |
total | 总数 | integer | 是 | |
data | 表单具体数据 | object | 是 |
data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | ID | integer | 是 | |
name | 客户名称 | string | 是 | |
style | 类型 | string | 是 | |
sale | 负责销售 | string | 是 | |
until | 剩余时间 | integer | 是 | 单位为天,可能为空 |
Response Data Json
{
"status": 0,
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 5,
"data": [
{
"id": 2,
"name": "浙江超维半导体有限公司",
"style": "company",
"sale": "李飒",
"until": 30,
},
{
"id": 4,
"name": "北京海淀软件园ICPARK",
"style": "park",
"sale": "",
"until": 0,
},
{
"id": 5,
"name": "北京超微半导体公司",
"style": "company",
"sale": "张三",
"until": null,
},
]
}
Error
Code | Message | Description |
---|---|---|
400 | invalid until param | 剩余天数无效 |
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 谢宇轩 | 创建 |
CreateCustomer 创建新的客户
创建新客户
创建一个新的客户
POST
: /api/customer--header 'Bearer: {token}'
--header 'Content-Type: application/json'
Request Data Json
{
"style": "company",
"name": "新客户公司"
}
HTTP Method
POST
HTTP Request
/api/customer
Request Parameters Query
无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
style | 客户类型 | enum | 是 | 见Style 的定义 |
name | 客户名称 | string | 是 |
Style.Schema
Value | Label | Tips |
---|---|---|
company | 公司客户 | |
park | 园区客户 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 表单具体数据 | object | 是 |
data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | ID | integer | 是 | |
name | 客户名称 | string | 是 | |
style | 类型 | string | 是 | |
sale | 对接销售 | string | 否 | |
created_at | 创建时间 | integer | 是 | |
updated_at | 最后修改时间 | integer | 是 | |
owner | 创建者管理员 | object | 是 | 见AdminManager定义 |
AdminManager
Title | Description | Type | Required | Tips |
---|---|---|---|---|
admin_id | 管理员ID | integer | 是 | |
name | 名称 | string | 是 |
Response Data Json
{
"status": 0,
"data": {
"id": 101,
"name": "新客户公司",
"style": "company",
"sale": "",
"created_at": 1234567890,
"updated_at": 1234567890,
"owner": {
"admin_id": 301,
"name": "管理员A"
}
}
}
Error
Code | Message | Description |
---|---|---|
400 | invalid style param | 客户类型参数无效 |
400 | invalid name param | 客户名称参数无效, 不可以重名 |
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
CustomerDetail 客户的详情
查看客户详情
查看某一个客户详情
GET
: /api/customer/{customer_id}--header 'Bearer: {token}'
HTTP Method
GET
HTTP Request
/api/customer/{customer_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 表单具体数据 | object | 是 |
data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | ID | integer | 是 | |
name | 客户名称 | string | 是 | |
style | 类型 | string | 是 | |
sale | 对接销售 | string | 否 | |
contracts | 合同对象信息 | null or objects | 否 | 见Contract定义 |
sub_members | 子账户信息 | array of objects | 否 | 见Sub Member定义 |
created_at | 创建时间 | integer | 是 | |
updated_at | 最后修改时间 | integer | 是 | |
owner | 创建者管理员 | object | 是 | 见AdminManager定义 |
Contract
Title | Description | Type | Required | Tips |
---|---|---|---|---|
contract_id | ID | integer | 是 | |
title | 合同标题 | string | 是 | |
content_type | 附件格式 | string | 是 | |
attachment | 合同附件地址 | string | 是 | 可以打开的URI |
customer_uniq_key | 文件唯一标识 | string | 是 | |
created_at | 创建时间 | integer | 是 | |
updated_at | 最后修改时间 | integer | 是 | |
last_modified_by | 最后修改管理员 | object | 是 | 见AdminManager定义 |
Sub Member
Title | Description | Type | Required | Tips |
---|---|---|---|---|
member_id | 成员ID | integer | 是 | |
username | 账号名称 | string | 是 | |
password | 账号密码 | string | 是 | |
nickname | 昵称 | string | 否 | |
intro | 简介/描述/备注 | string | 否 | |
mobile | 手机号 | string | 否 | |
邮箱 | string | 否 | ||
until | 有效期 | integer | 是 | |
remaining_time | 剩余时间 | string | 是 | 单位为天 |
valid | 可用状态 | integer | 是 | 1 意为有效期内,合作中,反之为0 |
created_at | 创建时间 | integer | 是 | |
updated_at | 最后修改时间 | integer | 是 | |
last_modified_by | 最后修改管理员 | object | 是 | 见AdminManager定义 |
AdminManager
Title | Description | Type | Required | Tips |
---|---|---|---|---|
admin_id | 管理员ID | integer | 是 | |
name | 名称 | string | 是 |
Response Data Json
{
"status": 0,
"data": {
"id": 101,
"name": "新客户公司",
"style": "company",
"sale": "里斯",
"contracts": {
"contract_id": 201,
"title": "合同标题1",
"content_type": "application/pdf",
"customer_uniq_key": "63644808-8230-4c05-86e3-fd48be4ef61b",
"attachment": "https://example.com/contract1.pdf",
"created_at": 1234567890,
"updated_at": 1234567890,
"last_modified_by": {
"admin_id": 301,
"name": "管理员A"
}
},
"sub_members": [
{
"member_id": 401,
"username": "user1",
"password": "password1",
"remaining_time": "2024-12-31",
"until": 100,
"valid": 1,
"created_at": 1234567890,
"updated_at": 1234567890,
"last_modified_by": {
"admin_id": 301,
"name": "管理员A"
}
},
{
"member_id": 402,
"username": "user2",
"password": "password2",
"remaining_time": "2024-12-31",
"until": 150,
"valid": 1,
"created_at": 1234567890,
"updated_at": 1234567890,
"last_modified_by": {
"admin_id": 302,
"name": "管理员B"
}
}
],
"created_at": 1234567890,
"updated_at": 1234567890,
"owner": {
"admin_id": 301,
"name": "管理员A"
}
}
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
ModifyCustomerInfo 更新客户信息
修改客户信息
只修改客户的销售信息
PUT
: /api/customer/{customer_id}--header 'Bearer: {token}'
--header 'Content-Type: application/json'
Request Data Json
{
"sale": "张三"
}
HTTP Method
PUT
HTTP Request
/api/customer/{customer_id}
Request Parameters Query
无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
sale | 对接销售 | string | 否 | 客户的对接销售姓名 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 表单具体数据 | object | 否 |
data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | ID | integer | 是 | |
name | 客户名称 | string | 是 | |
style | 类型 | string | 是 | |
sale | 对接销售 | string | 否 | |
created_at | 创建时间 | integer | 是 | |
updated_at | 最后修改时间 | integer | 是 |
Response Data Json
{
"status": 0,
"data": {
"id": 101,
"name": "客户公司",
"style": "company",
"sale": "修改后的销售姓名",
"created_at": 1234567890,
"updated_at": 1234567890
}
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
2024/05/09 | 易初 | 修改去掉合同的编辑 |
ModifySubMemberInfo 修改客户成员信息
修改客户成员信息
只修改客户的销售信息
PUT
: /api/customer/{id}/member/{member_id}/info--header 'Bearer: {token}'
--header 'Content-Type: application/json'
Request Data Json
{
"status": 0,
"data": {
"member_id": 202
}
}
HTTP Method
PUT
HTTP Request
/api/customer/{id}/member/{member_id}/info
Request Parameters Query
无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
nickname | 昵称 | string | 否 | |
intro | 简介/描述/备注 | string | 否 | |
avatar | 头像 | string | 否 | |
mobile | 手机号 | string | 否 | |
邮箱 | string | 否 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 表单具体数据 | object | 否 |
data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
member_id | ID | integer | 是 |
Response Data Json
{
"status": 0,
"data": {
"member_id": 202
}
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/07/05 | 朱思嘉 | 创建 |
DeleteCustomer 删除客户
软删除客户
软删除客户,将客户标记为已删除状态,不会立即从数据库中移除
DELETE
: /api/customer/{customer_id}--header 'Bearer: {token}'
HTTP Method
DELETE
HTTP Request
/api/customer/{customer_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 |
Response Data Json
{
"status": 0
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
CreateCustomerContract 创建客户合同
创建企业合同
创建一个新的企业合同
POST
: /api/customer/{customer_id}/pact--header 'Bearer: {token}'
--header 'Content-Type: application/json'
HTTP Method
POST
HTTP Request
/api/customer/{customer_id}/pact
Request Parameters Query
无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
title | 合同标题 | string | 是 | |
content_type | 附件格式 | string | 是 | |
attachment | 合同附件地址 | string | 是 | 可以打开的 URI |
customer_uniq_key | 文件唯一标识 | string | 是 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时的错误信息 | object | 否 | |
data | 创建的合同信息 | object | 否 | 见 Contract Info 定义 |
Contract Info
Title | Description | Type | Required | Tips |
---|---|---|---|---|
contract_id | 合同ID | integer | 是 | |
title | 合同标题 | string | 是 | |
content_type | 附件格式 | string | 是 | mime type |
attachment | 合同附件地址 | string | 是 | 可以打开的 URI |
customer_uniq_key | 文件唯一标识 | string | 是 | |
created_at | 创建时间 | integer | 是 | |
updated_at | 最后修改时间 | integer | 是 | |
last_modified_by | 最后修改管理员 | object | 是 | 见AdminManager定义 |
AdminManager
Title | Description | Type | Required | Tips |
---|---|---|---|---|
admin_id | 管理员ID | integer | 是 | |
name | 名称 | string | 是 |
Response Data Json
{
"status": 0,
"data": {
"contract_id": 101,
"title": "合同标题",
"content_type": "application/pdf",
"attachment": "https://example.com/contract.pdf",
"customer_uniq_key": "63644808-8230-4c05-86e3-fd48be4ef61b",
"created_at": 1649244000,
"updated_at": 1649244000
}
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/05/09 | 易初 | 创建 |
DeleteCustomerPact 删除合同
删除合同
软删除合同,将合同标记为已删除状态,不会立即从数据库中移除
DELETE
: /api/customer/{customer_id}/pact/{contract_id}--header 'Bearer: {token}'
HTTP Method
DELETE
HTTP Request
/api/customer/{customer_id}/pact/{contract_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 |
Response Data Json
{
"status": 0
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/28 | 朱思嘉 | 创建 |
Members API 成员子账户
客户子账户相关的API
BulkCreateSubMembers 批量新增成员
批量新增子成员
为指定客户批量新增子成员,自动生成账号密码
POST
: /api/customer/{customer_id}/member--header 'Bearer: {token}'
--header 'Content-Type: application/json'
Request Data Json
{
"count": 2,
"until": 7
}
HTTP Method
POST
HTTP Request
/api/customer/{customer_id}/member
Request Parameters Query
无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
count | 子成员个数 | integer | 是 | |
until | 有效期 | integer | 是 | 天数 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 表单具体数据 | []Sub Member | 否 | 详细见 Sub Member |
Sub Member
Title | Description | Type | Required | Tips |
---|---|---|---|---|
member_id | 成员ID | integer | 是 | |
username | 账号名称 | string | 是 | |
password | 账号密码 | string | 是 | |
until | 有效期 | integer | 是 | |
remaining_time | 剩余时间 | string | 是 | 单位为天 |
valid | 可用状态 | integer | 是 | 1 意为有效期内,合作中,反之为0 |
created_at | 创建时间 | integer | 是 | |
updated_at | 最后修改时间 | integer | 是 | |
last_modified_by | 最后修改管理员 | object | 是 | 见AdminManager定义 |
AdminManager
Title | Description | Type | Required | Tips |
---|---|---|---|---|
admin_id | 管理员ID | integer | 是 | |
name | 名称 | string | 是 |
Response Data Json
{
"status": 0,
"data": [
{
"member_id": 401,
"username": "user1",
"password": "password1",
"remaining_time": "2024-12-31",
"until": 7,
"valid": 1,
"created_at": 1234567890,
"updated_at": 1234567890,
"last_modified_by": {
"admin_id": 301,
"name": "管理员A"
}
},
{
"member_id": 402,
"username": "user2",
"password": "password2",
"remaining_time": "2024-12-31",
"until": 7,
"valid": 1,
"created_at": 1234567890,
"updated_at": 1234567890,
"last_modified_by": {
"admin_id": 301,
"name": "管理员A"
}
}
]
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
DELETE_SUB_MEMBER
删除子成员
删除指定ID的子成员
DELETE
: /api/customer/{customer_id}/member/{member_id}--header 'Bearer: {token}'
HTTP Method
DELETE
HTTP Request
/api/customer/{customer_id}/member/{member_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 |
Response Data Json
{
"status": 0
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
AddSubMemberSubPlan 新增订阅天数
为子成员新增订阅天数
为指定ID的子成员新增订阅天数
POST
: /api/customer/{customer_id}/member/{member_id}/sub-plan--header 'Bearer: {token}'
--header 'Content-Type: application/json'
Request Data Json
{
"until": 30
}
HTTP Method
POST
HTTP Request
/api/customer/{customer_id}/member/{member_id}/sub-plan
Request Parameters Query
无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
until | 新增订阅天数 | integer | 是 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 具体数据 | object | 否 | Sub Member |
Sub Member
Title | Description | Type | Required | Tips |
---|---|---|---|---|
member_id | 成员ID | integer | 是 | |
username | 账号名称 | string | 是 | |
password | 账号密码 | string | 是 | |
until | 有效期 | integer | 是 | |
remaining_time | 剩余时间 | string | 是 | 单位为天 |
valid | 可用状态 | integer | 是 | 1 意为有效期内,合作中,反之为0 |
created_at | 创建时间 | integer | 是 | |
updated_at | 最后修改时间 | integer | 是 | |
last_modified_by | 最后修改管理员 | object | 是 | 见AdminManager定义 |
AdminManager
Title | Description | Type | Required | Tips |
---|---|---|---|---|
admin_id | 管理员ID | integer | 是 | |
name | 名称 | string | 是 |
Response Data Json
{
"status": 0,
"data": {
"member_id": 401,
"username": "user1",
"password": "password1",
"remaining_time": "2024-12-31",
"until": 100,
"valid": 1,
"created_at": 1234567890,
"updated_at": 1234567890,
"last_modified_by": {
"admin_id": 301,
"name": "管理员A"
}
}
}
Error
Code | Message | Description |
---|---|---|
400 | invalid request params | 请求参数异常 |
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
ViewSubMemberMenuPermission 查看账号权限
查看子账号菜单权限
查看指定ID的子账号菜单权限,包含树型结构的菜单权限信息
GET
: /api/customer/{customer_id}/member/{member_id}/menu--header 'Bearer: {token}'
HTTP Method
GET
HTTP Request
/api/customer/{customer_id}/member/{member_id}/menu
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 菜单权限 | array | 是 | 见Menu Permission定义 |
Menu Permission
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | 权限ID | integer | 是 | |
name | 菜单名称 | string | 是 | |
label | 菜单标签 | string | 是 | |
has_permission | 是否拥有该菜单权限 | boolean | 是 | |
children | 子菜单列表 | array | 否 | 递归结构,与上方Menu Permission相同 |
Response Data Json
{
"status": 0,
"data": [
{
"id": 1,
"name": "dashboard",
"label": "仪表盘",
"has_permission": true
},
{
"id": 2,
"name": "orders",
"label": "订单管理",
"has_permission": true,
"children": [
{
"id": 3,
"name": "list",
"label": "订单列表",
"has_permission": true
},
{
"id": 4,
"name": "details",
"label": "订单详情",
"has_permission": false
}
]
},
{
"id": 5,
"name": "products",
"label": "产品管理",
"has_permission": false,
"children": [
{
"id": 6,
"name": "list",
"label": "产品列表",
"has_permission": false
},
{
"id": 7,
"name": "details",
"label": "产品详情",
"has_permission": false
}
]
}
]
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
ModifySubMemberMenuPermission 修改账号权限
修改子账号菜单权限
修改指定ID的子账号菜单权限,只修改权限,不会修改菜单基本属性
GET
: /api/customer/{customer_id}/member/{member_id}/menu--header 'Bearer: {token}'
--header 'Content-Type: application/json'
Request Data Json
{
"menus": [
{
"id": 1,
"name": "dashboard",
"label": "仪表盘",
"has_permission": true
},
{
"id": 2,
"name": "orders",
"label": "订单管理",
"has_permission": true,
"children": [
{
"id": 3,
"name": "list",
"label": "订单列表",
"has_permission": true
},
{
"id": 4,
"name": "details",
"label": "订单详情",
"has_permission": true
}
]
}
]
}
HTTP Method
PUT
HTTP Request
/api/customer/{customer_id}/member/{member_id}/menu
Request Parameters Query
无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
menu_permission | 菜单权限 | array | 是 | 见Menu Permission定义 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 菜单权限 | array | 是 | 见Changer 定义 |
Changer
Title | Description | Type | Required | Tips |
---|---|---|---|---|
count | 修改变动数量 | integer | 是 |
Response Data Json
{
"status": 0,
"data": {
"count": 3
}
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
Resource API 资源
系统资源相关的API
GetSalesList 销售信息列表
获取销售信息列表
获取系统中所有销售信息列表,支持模糊搜索
GET
: /api/resource/sales--header 'Bearer: {token}'
HTTP Method
GET
HTTP Request
/api/resource/sales
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
search | 搜索关键词 | string | 否 | 模糊搜索销售姓名 |
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时的错误信息 | object | 否 | |
data | 销售信息列表 | []string | 是 | 销售姓名 |
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
TYCCompaniesList 天眼查企业信息
天眼查企业信息列表
获取中天眼查企业信息列表,支持模糊搜索,搜索参数必填
GET
: /api/resource/company--header 'Bearer: {token}'
HTTP Method
GET
HTTP Request
/api/resource/company
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
search | 搜索关键词 | string | 是 | 模糊搜索企业名称,大于两个字时有搜索结果 |
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时的错误信息 | object | 否 | |
data | 企业信息列表 | []string | 是 | 企业名称 |
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/04/17 | 易初 | 创建 |
System API 系统设置
系统配置相关的API
GetMenusList 获取权限菜单列表
获取系统中全部的菜单列表
查看全部的菜单信息
GET
: /api/system/menu--header 'Bearer: {token}'
HTTP Method
GET
HTTP Request
/api/system/menu
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 菜单权限 | array | 是 | 见Menu Permission定义 |
Menu Permission
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | 权限ID | integer | 是 | |
name | 菜单名称 | string | 是 | |
label | 菜单标签 | string | 是 | |
status | 是否开启 | boolean | 是 | |
children | 子菜单列表 | array | 否 | 递归结构,与上方Menu Permission相同 |
Response Data Json
{
"status": 0,
"data": [
{
"id": 1,
"name": "dashboard",
"label": "仪表盘",
"status": true
},
{
"id": 2,
"name": "orders",
"label": "订单管理",
"status": true,
"children": [
{
"id": 3,
"name": "list",
"label": "订单列表",
"status": true
},
{
"id": 4,
"name": "details",
"label": "订单详情",
"status": false
}
]
},
{
"id": 5,
"name": "products",
"label": "产品管理",
"status": false,
"children": [
{
"id": 6,
"name": "list",
"label": "产品列表",
"status": false
},
{
"id": 7,
"name": "details",
"label": "产品详情",
"status": false
}
]
}
]
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/05/29 | 易初 | 创建 |
ModifyMenusStatus 修改全局的菜单状态
修改系统中菜单权限的状态
修改全局的菜单的状态
PUT
: /api/system/menu--header 'Bearer: {token}'
--header 'Content-Type: application/json'
Request Data Json
{
"menus": [
{
"id": 8,
"name": "舆情监测",
"label": "jwopinion",
"status": 1,
"show_recommend": 0,
"show_search": 1,
"show_homepage": 1,
"children": [
{
"id": 9,
"name": "行业热点",
"label": "jwopinion_hot",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 10,
"name": "行业关注",
"label": "jwopinion_follow",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
}
]
},
{
"id": 3,
"name": "海外报道",
"label": "overseas",
"status": 1,
"show_recommend": 1,
"show_search": 1,
"show_homepage": 0,
"children": [
{
"id": 4,
"name": "中美热点",
"label": "overseas_hot",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 5,
"name": "前线报道",
"label": "overseas_frontline",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": [
{
"id": 6,
"name": "国际资讯",
"label": "frontline_internation",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 7,
"name": "重大项目",
"label": "frontline_project",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
}
]
}
]
},
{
"id": 11,
"name": "政策指引",
"label": "policy",
"status": 1,
"show_recommend": 1,
"show_search": 1,
"show_homepage": 1,
"children": [
{
"id": 12,
"name": "政策申报",
"label": "policy_declare",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 13,
"name": "项目专刊",
"label": "policy_project",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 14,
"name": "政策专刊",
"label": "policy_journal",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
}
]
},
{
"id": 15,
"name": "集微咨询",
"label": "consult",
"status": 1,
"show_recommend": 0,
"show_search": 1,
"show_homepage": 1,
"children": [
{
"id": 16,
"name": "集微报告",
"label": "report",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 17,
"name": "集微咨询报告",
"label": "consult_report",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 18,
"name": "并购报告",
"label": "consult_merge",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 19,
"name": "行业周刊",
"label": "consult_industry",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 20,
"name": "存储市场报告",
"label": "consult_store",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 21,
"name": "EDA市场报告",
"label": "consult_eda",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
}
]
},
{
"id": 22,
"name": "行业报告",
"label": "industry",
"status": 1,
"show_recommend": 0,
"show_search": 1,
"show_homepage": 1,
"children": [
{
"id": 23,
"name": "外部报告",
"label": "industry_external",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 24,
"name": "机构报告",
"label": "industry_institution",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 25,
"name": "Gartner文档",
"label": "industry_gartner",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
}
]
},
{
"id": 26,
"name": "贸易管制",
"label": "trade",
"status": 1,
"show_recommend": 0,
"show_search": 1,
"show_homepage": 0,
"children": []
},
{
"id": 27,
"name": "企业动态",
"label": "firm_dynamic",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 1,
"children": [
{
"id": 28,
"name": "企业查询",
"label": "firm_find",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 29,
"name": "企业信息变动",
"label": "firm_change",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
}
]
},
{
"id": 30,
"name": "优质项目",
"label": "top_project",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": [
{
"id": 1,
"name": "企业库",
"label": "company",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 2,
"name": "项目库",
"label": "project",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
}
]
},
{
"id": 32,
"name": "设置",
"label": "settings",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
},
{
"id": 31,
"name": "AI大模型",
"label": "ai",
"status": 1,
"show_recommend": 0,
"show_search": 0,
"show_homepage": 0,
"children": []
}
]
}
HTTP Method
PUT
HTTP Request
/api/system/menu/{id}
Request Parameters Query
无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | 权限ID | integer | 是 | |
name | 菜单名称 | string | 是 | |
label | 菜单标签 | string | 是 | |
status | 是否开启 | boolean | 是 | |
children | 子菜单列表 | array | 否 | 递归结构,与上方Menu Permission相同 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | 菜单权限 | array | 是 | 见Changer 定义 |
Changer
Title | Description | Type | Required | Tips |
---|---|---|---|---|
count | 受影响的数量 | integer | 是 |
Response Data Json
{
"status": 0,
"data": {
"count": 3
}
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/05/29 | 易初 | 创建 |
GetGlobalBanners 获取全局的轮播
获取系统中内置的轮播信息
获取系统中内置的轮播信息
GET
: /api/system/banner--header 'Bearer: {token}'
--header 'Content-Type: application/json'
HTTP Method
GET
HTTP Request
/api/system/banner
Request Parameters Query
暂无
Request Parameters Body
暂无
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | Banner | array | 是 | value见Banner定义 |
Banner
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | ID | integer | 否 | |
location | 位置 | integer | 否 | |
customer_uniq_key | 唯一标识 | integer | 是 | |
src | 地址 | string | 是 | |
href | 链接 | string | 否 | |
start_at | 生效时间 | integer | 否 | |
end_at | 结束时间 | integer | 否 |
Response Data Json
{
"status": 0,
"data": [
{
"id": 1,
"location": 1,
"src": "https://s.laoyaoba.com/image/1.jpg",
"customer_uniq_key": "12asdasvxcx",
"href": "",
"start_at": 1234567890,
"end_at": 9876543210
},
{
"id": 2,
"location": 2,
"src": "https://s.laoyaoba.com/image/1.jpg",
"customer_uniq_key": "12asdasvxcx",
"href": "",
"start_at": 1234567890,
"end_at": 9876543210
}
]
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/05/29 | 易初 | 创建 |
2024/06/04 | 易初 | 修改空的定义 |
ModifyBannerInfo 修改Banner设置
修改系统中内置的轮播信息
修改系统中内置的定位1的轮播信息(仅传递修改属性即可)
PUT
: /api/system/banner/1--header 'Bearer: {token}'
--header 'Content-Type: application/json'
Request Data Json
{
"src": "https://s.laoyaoba.com/image/1.jpg",
"customer_uniq_key": "12asdasvxcx",
"href": "",
"start_at": 1234567890,
"end_at": 9876543210
}
HTTP Method
PUT
HTTP Request
/api/system/banner/{location}
Request Parameters Query
暂无
Request Parameters Body
Title | Description | Type | Required | Tips |
---|---|---|---|---|
customer_uniq_key | 唯一标识 | integer | 是 | 修改的时候必须和src成对出现! |
src | 地址 | string | 是 | |
href | 链接 | string | 否 | |
start_at | 生效时间 | integer | 否 | |
end_at | 结束时间 | integer | 否 | 理论上不会出现空,如果不过期就设置很久 |
Response Data
Title | Description | Type | Required | Tips |
---|---|---|---|---|
status | 状态:0成功 非0失败 | integer | 是 | |
errors | status非0时,返回错误信息,键值对 | object | 否 | |
data | Banner | array | 是 | 见Banner定义 |
Banner
Title | Description | Type | Required | Tips |
---|---|---|---|---|
id | ID | integer | 否 | |
location | 位置 | integer | 否 | |
customer_uniq_key | 唯一标识 | integer | 是 | |
src | 地址 | string | 是 | |
href | 链接 | string | 否 | |
start_at | 生效时间 | integer | 否 | |
end_at | 结束时间 | integer | 否 |
Response Data Json
{
"status": 0,
"data":{
"id": 2,
"location": 2,
"src": "https://s.laoyaoba.com/image/1.jpg",
"customer_uniq_key": "12asdasvxcx",
"href": "",
"start_at": 1234567890,
"end_at": 9876543210
},
}
Error
无
Log
日期 | 作者 | 内容 |
---|---|---|
2024/05/29 | 易初 | 创建 |
2024/06/04 | 易初 | 修改空的定义 |
Help 帮助
在index.html.md
文件中进行编辑目录和文档总体结构,然后在includes目录中添加对应的模块。
文档使用Markdown语言排版。
Markdown格式示例
# 标题
## 二级标题
### .......
```json
代码块
```
表格
表头 | 表头
---------- | -------
内容 | 内容
内容 | 内容
`Something`
表格
表头 | 表头 |
---|---|
内容 | 内容 |
内容 | 内容 |
无序列表
无序列表
Json
是没有注释的 避免在json中写注释
Something
高亮
加粗 粗体
横线
下划线
斜体