Jiwei
ACP ADMIN API WIKI 文档
Activity Checkin Platform Admin API WIKI
是活动签到后台服务的API文档
接口调用的参数格式
目前接口部分使用 HTTP 的 Body 来进行参数传递,接口支持 application/json 的 Body 格式
同时也支持 application/x-www-form-urlencoded 的 Body 格式
两种方式均需要在 Header 中注明内容类型的属性。
请勿使用from-data传递Payload
鉴权
接口使用的是基于 rfc6750 的Bearer Token 基于JWT来进行鉴权
我们的Bearer Token 使用的是,在实际业务中并不需要每次调用接口前都去获取Token。
在Token的有效期内可以直接用现有的Token进行接口调用,目前我们的Token 有效期为24小时,过期后则立即失效。此外客户端也可以对Token进行自解,来判断token有效期
访问需要鉴权的接口共需要两步:
判断当前Token是否存在或过期,若有异常则重新通过登录授权接口获取Token 。(通过账号密码进行验证,移动端还额外需要设备唯一标识)
在Http Header中携带已保存的Token。
接口返回说明
第一层 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 返回码
errors
为一个对象,会给出status的具体错误原因描述,这个字段适用于程序开发中的错误调试,不应该把他的返回内容作为代码逻辑判断的条件。也不应直接在前端页面显示。
示例
{
"status": 1,
"errors": {
"account": " account 不能为空",
"code": " code 不能为空"
}
}
接口地址说明
http | https | 参考文档 | |
---|---|---|---|
线下 | http://120.76.245.68:8281 | ||
正式 | http://dashboard.acp.ijiwei.com | http://47.107.239.240:7881/docs/Acp/checkin/ |
系统鉴权
获取Bearer Token
GET_BEARER_TOKEN
获取系统中所使用的
token
--Header
: token: Bearer {token}
POST
: /api/access/token--data-raw: json
json { "phone":"17611111111", "password":"123456" }
Request Body:
json { "phone":"17611111111", "password":"123456" }
Response Body:
{
"status": 0,
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImFjcF9uYW1lIn0.eyJpZCI6Ik1RPT0iLCJhdWQiOiJhZG1pbiIsImlzcyI6ImFjcF9hZG1pbiIsInN1YiI6ImFjcF9hZG1pbl9kZXZfdXNlciIsImlhdCI6MTY1MDM1MzkzMywiZXhwIjoxNjUwNDQwMzMzfQ.s4fhLuK8KQP1MkriRG2oX85ecbZewJLT8ENjJfJ-fDI",
"token_method": "HS256",
"token_type": "Bearer",
"expire_time": 1650440333
}
Token Payload:
{
"aud": "17611111111",
"iss":"acp-admin",
"sub":"acp_admin_dev_user",
"iat":1573116338,
"exp":1573119938,
"name": "admin"
}
HTTP Method
POST
HTTP Request
/api/access/token
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
phone | 手机号 | String | 是 | |
password | 密码 | String | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | int | 状态 0 正常 1为失败 | |
token | string | token 字符串 |
|
token_method | string | 加密方式 | |
token_type | string | token 的类型,目前应该固定为 Bearer |
|
expire_time | int | 过期时间 |
Payload
Title | Description | Type | Tips |
---|---|---|---|
aud | string | 用户唯一凭证 | |
iss | string | 颁发方 | |
sub | int | 使用方 | |
iat | int | 颁发时间 | |
exp | int | 过期时间 | |
name | string | 使用方名称 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
2022/4/29 | 朱思嘉 | 修改 |
会议管理
会议列表
GET_ACTIVITY_LIST
获取会议列表
--Header
: token: Bearer {token}
GET
: /api/activity?page=1&limit=1&label=沙发扶手Response Body:
{
"status": 0,
"current_page": 1,
"last_page": 4,
"per_page": 1,
"total": 4,
"data": [
{
"id": 67,
"label": "沙发扶手",
"code": "056b019d",
"status": 0,
"is_bind": 0,
"created_at": 1650277492,
"guests": 0,
"places": [
{
"id": 96,
"label": "场馆101",
"activity_id": 67,
"status": 1
},
{
"id": 95,
"label": "场馆100",
"activity_id": 67,
"status": 1
}
],
"rooms": [
{
"id": 64,
"label": "的法大师傅十分",
"name" : "会议名称",
"is_set_permission": false,
"activity_id": 67,
"status": 1,
"start_time": 1650273644,
"end_time": 1650273667,
"type": 1,
"opening_time": "17:20-17:21",
"hold_day": "04月18日",
"is_active": true,
"cover_type": "默认类型"
}
]
}
]
}
HTTP Method
GET
HTTP Request
/api/activity
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
page | 页数 | string | 否 | 活动页数 |
limit | 条数 | string | 否 | 条数,默认20 |
label | 活动名称 | string | 否 | 搜索条件 |
Request Parameters Body
无
Response Data
Checkin activity Object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
current_page | 当前页 | Number | |
last_page | 最后页 | Number | |
per_page | 每页条数 | Number | |
total | 总数 | Number | |
data | 返回数据 | Object | |
data.id | activity ID |
Number | |
data.label | 活动名称 | String | |
data.code | 活动唯一标识 | String | |
data.status | 活动状态 | Number | 0:未发布 1:已发布 |
data.is_bind | 是否绑定 | Number | |
data.guests | 访客数 | Number | |
data.created_at | 创建时间 | Number | |
data.places | 场馆 | Object | |
data.rooms | 会场 | Object |
Places Object
Title | Description | Type | Tips |
---|---|---|---|
id | Place ID |
Number | |
label | 场馆名称 | String | |
activity_id | 会议ID | Number | |
status | 场馆状态 | Number | 0:未发布 1:已发布 |
Rooms Object
Title | Description | Type | Tips |
---|---|---|---|
id | Room ID |
Number | |
label | 展厅会议 | String | |
activity_id | 会议ID | Number | |
name | 展厅名称 | String | |
is_set_permission | 是否具有设置权限 | Bool | |
status | 会场状态 | Number | 0:未发布 1:已发布 |
start_time | 开始时间 | Number | |
end_time | 结束时间 | Number | |
type | 会场类型 | Number | 1: 默认类型,2:收费,3:邀请,4:校友会 |
is_active | 是否发布 | Bool | |
cover_type | 中文类型 | String | 1: 默认类型,2:收费,3:邀请,4:校友会 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
2022/5/13 | 李晓东 | 修改 |
会议详情
GET_ACTIVITY_INFO
获取会议详情
--Header
: token: Bearer {token}
GET
: /api/activity/32Response Body:
{
"status": 0,
"data": {
"id": 1,
"label": "test3",
"code": "d3c7e82e",
"status": 1,
"is_active": true,
"places": [
{
"id": 2,
"label": "华裔29日签到"
},
{
"id": 1,
"label": "华裔28日签到"
}
],
"rooms": [
{
"id": 10,
"name": "展厅名称",
"label": "默认展厅",
"type": 2,
"cover_type": "收费展厅",
"intro": null,
"start_time": 1649745080,
"end_time": 1681194680
},
{
"id": 9,
"name": "展厅名称",
"label": "默认展厅",
"type": 1,
"cover_type": "普通展厅",
"intro": null,
"start_time": 1649745080,
"end_time": 1681194680
},
{
"id": 7,
"name": "展厅名称",
"label": "默认展厅",
"type": 1,
"cover_type": "普通展厅",
"intro": null,
"start_time": 1649745080,
"end_time": 1649917880
},
{
"id": 6,
"name": "展厅名称",
"label": "默认展厅",
"type": 1,
"cover_type": "普通展厅",
"intro": null,
"start_time": 1649658680,
"end_time": 1649831480
}
],
"tags": [
{
"id": 45,
"name": "霍霍你",
"count": 1,
"select_type": 1,
"show_type": 1,
"created_at": 1650450099
},
{
"id": 44,
"name": "是否参加上汽",
"count": 1,
"select_type": 1,
"show_type": 1,
"created_at": 1650450032
},
{
"id": 42,
"name": "嘉宾类型1",
"count": 0,
"select_type": 1,
"show_type": 1,
"created_at": 1650449958
},
{
"id": 22,
"name": "支付状态",
"count": 1,
"select_type": 1,
"show_type": 1,
"created_at": 1650007896
},
{
"id": 21,
"name": "嘉宾类型",
"count": 1,
"select_type": 1,
"show_type": 1,
"created_at": 1650007841
}
]
}
}
HTTP Method
GET
HTTP Request
/api/activity/{activity_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Checkin activity Object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 返回数据 | Object | |
data.id | activity ID |
Number | |
data.label | 活动名称 | String | |
data.code | 活动唯一标识 | String | |
data.status | 活动状态 | Number | 1: 发布, 0:未发布 |
data.is_active | 活动是否发布 | Bool | true: 发布, false: 未发布 |
data.places | 场馆 | Object | |
data.rooms | 会场 | Object | |
data.tags | 备注 | Object |
Places Object
Title | Description | Type | Tips |
---|---|---|---|
id | Place ID |
Number | |
label | 场馆名称 | String |
Rooms Object
Title | Description | Type | Tips |
---|---|---|---|
id | Room ID |
Number | |
name | 展厅名称 | String | |
label | 展厅会议 | String | |
start_time | 开始时间 | Number | |
end_time | 结束时间 | Number | |
type | 会场类型 | Number | 1: 默认类型,2:收费,3:邀请,4:校友会 |
is_active | 是否发布 | Bool | |
cover_type | 中文类型 | String | 1: 默认类型,2:收费,3:邀请,4:校友会 |
intro | 备注 | String |
Tags Object
Title | Description | Type | Tips |
---|---|---|---|
id | Tag ID |
Number | |
name | 备注名称 | String | |
count | 访客引用总数 | String | |
select_type | 作为搜索项 | Number | 0:否, 1:是 |
show_type | 作为展示项 | Number | 0:否, 1:是 |
created_at | 创建时间 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
2022/5/13 | 李晓东 | 修改 |
创建会议
ADD_ACTIVITY_INFO
创建会议信息
--Header
: token: Bearer {token}
POST
: /api/activityRequest Body:
{
"activity":{
"label":"沙发扶手"
},
"place": [
{"label":"场馆100"},
{"label":"场馆101"}
],
"room":[
{
"name":"展厅名称",
"label":"展厅会议",
"intro":"备注100",
"type": 1,
"start_time":"1650273644",
"end_time": "1650273667"
}
],
"tags":[
"是否参加校友会",
"是否参加分析师大会"
]
}
Response Body:
{
"status": 0
}
HTTP Method
POST
HTTP Request
/api/activity
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
activity | 活动相关信息 | Object | 是 | |
place | 场馆相关信息 | Object | 是 | |
room | 会场相关信息 | Object | 是 | |
tags | 备注信息 | String | 否 | 多个备注通过“,”分割 |
Activity Info Object
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
label | 活动名称 | String | 是 |
Place Info Object
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
label | 场馆名称 | string | 是 |
Room Info Object
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
name | 展厅名称 | string | 是 | |
label | 展厅会议 | string | 是 | |
type | 展厅类型 | string | 是 | |
intro | 备注 | string | 否 | |
start_time | 开始时间 | Int | 是 | |
end_time | 开始时间 | Int | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
2022/5/13 | 李晓东 | 新增字段 |
编辑会议
MODIFY_ACTIVITY_INFO
修改会议信息
--Header
: token: Bearer {token}
POST
: /api/activity/35Request Body:
{
"label":"test3"
}
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/activity/{activity_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
label | 活动名称 | String | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
2022/4/24 | 谢宇轩 | 修改请求方法为PUT |
删除会议
DEL_ACTIVITY_INFO
删除会议
--Header
: token: Bearer {token}
DELETE
: /api/activity/1Response Body:
{
"status": 0
}
HTTP Method
DELETE
HTTP Request
/api/activity/{activity_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
发布会议
RELEASE_ACTIVITY_INFO
发布会议
--Header
: token: Bearer {token}
PUT
: /api/activity/1/releaseResponse Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/activity/{activity_id}/release
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
2022/4/24 | 谢宇轩 | 修改路由地址 |
绑定会议
BIND_ACTIVITY_OF_ACTIVITY
发布会议
GET
: /api/activity/bindRequest Body: 无
Response Body:
{
"status": 0,
"data": {
"id": 2,
"uuid": "1a2b112d",
"name": "yearsMeetingCheckin",
"label": "投资联盟",
"start_time": 1639391920,
"end_time": 1640947125,
"status": 1,
"is_bind": 1,
"created_at": 1639391930,
"updated_at": 1650970061,
"is_active": true
}
}
HTTP Method
GET
HTTP Request
/api/activity/bind
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
code | 会议活动编码 | String | 8位活动编码 | |
start_time | 会议开始时间 | Int | 10位时间戳 | |
end_time | 会议结束时间 | Int | 10位时间戳 |
Request Parameters Body
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 会议详情 | Array |
data Object
Title | Description | Type | Tips |
---|---|---|---|
id | id | Int | |
uuid | 会议编码 | String | |
name | 会议名字 | String | |
label | 会议标识 | String | |
start_time | 会议活动开始时间 | Int | |
end_time | 会议活动结束时间 | Int | |
status | 活动状态 | Int | |
is_bind | 是否绑定 | Int | |
created_at | 创建时间 | Int | |
updated_at | 更新时间 | Int | |
is_active | 会议活动状态 | Bool |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/26 | 李世星 | 新增 |
查看速率
SYNC_ROBOT_HEALTH_CHECK
发布会议
GET
: /api/sync-robot/health-checkRequest Body: 无
Response Body:
{
"status": 0,
"data": {
"total": 428,
"speed": "0条/小时",
"last_success_at": 1652334321
}
}
HTTP Method
GET
HTTP Request
/api/sync-robot/health-check
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 会议详情 | Array |
data Object
Title | Description | Type | Tips |
---|---|---|---|
total | 总数据 | Int | |
speed | 正在同步速率 | String | |
last_success_at | 最后同步数据时间 | Int | 10位时间戳 |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/5/12 | 李世星 | 新增 |
场馆管理
添加场馆
ADD_PLACE_INFO_OF_ACTIVITY
在会议下添加场馆
--Header
: token: Bearer {token}
POST
: /api/activity/35/placeRequest Body:
{
"label": "场馆10"
}
Response Body:
{
"status": 0
}
HTTP Method
POST
HTTP Request
/api/activity/{activity_id}/place
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
label | 场馆名称 | string | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
删除场馆
DEL_PLACE_INFO
删除场馆
--Header
: token: Bearer {token}
DELETE
: /api/place/31Response Body:
{
"status": 0
}
HTTP Method
DELETE
HTTP Request
/api/place/{place_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
编辑场馆
MODIFY_PLACE_INFO
编辑场馆
PUT
: /api/place/42Request Body:
{
"label":"场馆毕竟色弱"
}
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/place/{place_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
label | 场馆名称 | string | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
会场管理
添加会场
ADD_ROOM_INFO_OF_ACTIVITY
在会议下添加场馆
--Header
: token: Bearer {token}
POST
: /api/activity/39/roomRequest Body:
{
"name":"华栗大厅",
"label": "分析师大会",
"type": 3,
"intro":"test",
"start_time":1652617830,
"end_time":1655296230
}
Response Body:
{
"status": 0
}
HTTP Method
POST
HTTP Request
/api/activity/{activity_id}/room
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
name | 展厅名称 | string | 是 | |
label | 会场名称 | string | 是 | |
type | 会场类型 | Int | 是 | 1: 普通,2:收费,3:邀请,4:校友会 |
intro | 备注 | string | 否 | |
start_time | 开始时间 | Int | 是 | |
end_time | 开始时间 | Int | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
删除会场
DEL_ROOM_INFO
删除场馆
--Header
: token: Bearer {token}
DELETE
: /api/room/31Response Body:
{
"status": 0
}
HTTP Method
DELETE
HTTP Request
/api/room/{room_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
编辑会场
MODIFY_ROOM_INFO
编辑会场
--Header
: token: Bearer {token}
PUT
: /api/room/31Request Body:
{ "name":"华栗大厅", "label": "分析师大会", "type": 3, "intro":"test", "start_time":1652617830, "end_time":1655296230 }
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/room/{room_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
name | 展厅名称 | string | 是 | |
label | 会场名称 | string | 是 | |
type | 会场类型 | Int | 是 | 1: 普通,2:收费,3:邀请,4:校友会 |
intro | 备注 | string | 否 | |
start_time | 开始时间 | Int | 是 | |
end_time | 开始时间 | Int | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
会场详情
GET_ROOM_INFO
会场详情
--Header
: token: Bearer {token}
GET
: /api/room/31Response Body:
{
"status": 0,
"data": {
"id": "",
"label": "",
"intro": "",
"type": "",
"status": "",
"start_time": "",
"end_time": ""
}
}
HTTP Method
GET
HTTP Request
/api/room/{room_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Checkin Rooms Object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 返回数据 | Object | |
data.id | room Id |
Number | |
data.label | 会场名称 | String | |
data.type | 会场类型 | Number | 1: 普通,2:收费,3:邀请,4:校友会 |
data.intro | 备注 | String | |
data.status | 状态 | Number | 0:未生效, 1:生效 |
data.start_time | 开始时间 | Number | |
data.end_time | 结束时间 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
获取会场types
GET_ROOM_TYPES
获取会场types
--Header
: token: Bearer {token}
GET
: /api/room/typesResponse Body:
{
"status": 0,
"data": {
"1": "默认类型",
"2": "收费展厅",
"3": "邀请展厅",
"4": "校友会"
}
}
HTTP Method
GET
HTTP Request
/api/room/types
Request Parameters Query
无
Request Parameters Body
无
Response Data
Room Types Object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 返回types数据 | Object |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
备注管理
添加备注
ADD_TAG_INFO_OF_ACTIVITY
在会议下添加备注
--Header
: token: Bearer {token}
POST
: /api/activity/35/tagRequest Body:
{
"tags":"分析师大会,aaa"
}
Response Body:
{
"status": 0
}
HTTP Method
POST
HTTP Request
/api/activity/{activity_id}/tag
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
tags | 标签名称 | string | 是 | 多个标签需要“,”分割 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
删除备注
DEL_TAG_INFO_OF_ACTIVITY
删除备注
--Header
: token: Bearer {token}
DELETE
: /api/activity/35/tag/24Response Body:
{
"status": 0
}
HTTP Method
DELETE
HTTP Request
/api/activity/{activity_id}/tag/{tag_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
编辑备注
MODIFY_TAG_INFO
编辑备注
--Header
: token: Bearer {token}
PUT
: /api/tag/25Request Body:
{
"tag": "修改标签内容"
}
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/tag/{tag_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
tag | 备注名称 | string | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
将标签设置成为搜索项或者展示项
MODIFY_TAG_ATTRIBUTE_OF_ACTIVITY
将标签设置成为搜索项
--Header
: token: Bearer {token}
PUT
: /api/activity/35/tag/25Request Body:
{
"attribute":"show_type",
"value":1
}
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/activity/{activity_id}/tag/{tag_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
attribute | 属性名称 | String | 是 | show_type:展示项,select_type:搜索项 |
value | 属性值 | Number | 是 | 1: 作为, 0:不作为 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
标签列表
GET_TAG_LIST
获取本活动所有支持的tagKey
GET
: curl --location --request GET --X GET '/api/activity/23/tag?select_type=1' \ --header 'Bearer token'Response Body :
{
"status": 0,
"data": [
{
"id": 21,
"name": "嘉宾类型",
"pivot": {
"activity_id": 1,
"tag_id": 21,
"show_type": 1,
"select_type": 1
}
},
{
"id": 22,
"name": "支付状态",
"pivot": {
"activity_id": 1,
"tag_id": 22,
"show_type": 1,
"select_type": 1
}
},
{
"id": 42,
"name": "嘉宾类型1",
"pivot": {
"activity_id": 1,
"tag_id": 42,
"show_type": 1,
"select_type": 1
}
},
{
"id": 44,
"name": "是否参加上汽",
"pivot": {
"activity_id": 1,
"tag_id": 44,
"show_type": 1,
"select_type": 1
}
},
{
"id": 45,
"name": "霍霍你",
"pivot": {
"activity_id": 1,
"tag_id": 45,
"show_type": 1,
"select_type": 1
}
}
]
}
HTTP Method
GET
HTTP Request
/api/activity/{activityId}/tag
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
show_type | 是否展示 | Int | 否 | 1为展示 0 为不展示 |
select_type | 展示查询类型 | Int | 否 | 1为展示 0为不展示 |
name | 名称检索 | String | 否 | 名称模糊匹配 |
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
data | 标签列表 | Array |
data Object
Title | Description | Type | Tips |
---|---|---|---|
id | 标签ID | Int | |
name | 标签名称 | string |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/05/09 | 李世星 | 新增 |
访客管理
获取参与者数据的列表
GET_GUEST_LIST_OF_ACTIVITY
获取本次活动对应的参会人员数据列表
GET
: curl --location --request GET --X GET '/api/activity/1/guest?page=1&limit=20&name=郭哥&company=爱集微&tags=' \ --header 'Bearer token'Resquest params : ?order_num=&vague=&name=&phone=&company=&status=&limit=10&page=1
Response Body :
{
"status": 0,
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 5,
"data": [
{
"uuid": "28825d2a-3307-11ec-8961-0242c0a83002",
"order_num": "4294967296",
"name": "李星星",
"phone": 13333891144,
"company": "爱集微",
"position": "开发",
"type": {
"id": 1,
"name": "default",
"label": "普通嘉宾",
"color": "#FFFFFF"
},
"created_at": 1636015001,
"updated_at": 1636025002,
"place_sign": [
{
"id": 217,
"place": "汽车峰会下午场",
"model": "手动",
"time": 1650511406,
"supervise": "默认管理员"
}
],
"room_sign": [
{
"id": 7,
"room": "默认展厅",
"model": 1,
"time": 1650571513,
"supervise": "易初"
}
],
"tags": [],
"rooms": [
{
"id": 6,
"name": "默认展厅6",
"label": "默认展厅",
"type": 1,
"status": 1,
"start_time": 1649658680,
"end_time": 1649831480,
"allow_entry": false,
"opening_time": "14:31-14:31",
"hold_day": "04月11日",
"is_active": true,
"cover_type": "普通展厅",
"is_set_permission": false,
"own_attribute": ""
}
]
}
]
}
HTTP Method
GET
HTTP Request
/api/activity/{activity_id}/guest
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
order_num | 订单号 | String | 否 | |
vague | 搜索全部(包含名称手机号公司) | String | 否 | |
name | 名称 | String | 否 | |
phone | 手机号 | Int | 否 | |
company | 公司 | String | 否 | |
room_id | 对应展厅id | Int | 否 | |
status | 签到状态 | String | 否 | all 为全部 has_checkin 签到 un_checkin 未签到 |
tag_key | 所属标签key值 | String | 否 | 附加信息 标签key名称 |
tag_value | 所属标签value值 | String | 否 | 附加信息 标签key对应值 |
limit | 每页数据 | Int | 否 | 默认20 limit -1时,获取全部数据,不进行分页 |
page | 当前页 | Int | 否 | 默认1 |
Request Parameters Body
Response Data
guest Object
Title | Description | Type | Tips |
---|---|---|---|
uuid | 唯一凭证 | String | |
order_num | 订单号 | String | |
name | 参会者名称 | String | |
phone | 参会者手机号 | Int | |
company | 参会者所属公司 | String | |
position | 参会者职位 | String | |
permission | 参会者权限 | String | |
notes | 参会者额外信息 | Array | |
type | 参会者类型 | type Object | |
created_at | 添加时间 | Int | |
updated_at | 更新时间 | Int | |
place_sign | 参会者场馆签到记录 | Array | |
room_sign | 参会者展厅签到记录 | Array | |
tags | 附加信息 | Array | |
rooms | 参会者所能进入参会房间信息 | Array | |
rooms_num | 参会者所能进入参会房间数量 | Int |
type
Title | Description | Type | Tips |
---|---|---|---|
id | TypeId | Int | |
name | 嘉宾类型名称 | String | |
label | 嘉宾类型标识 | String | |
color | 嘉宾类型颜色 | String | #FFFF |
place_sign
Title | Description | Type | Tips |
---|---|---|---|
id | 签到记录ID | Int | |
place | 签到地点 | String | |
mode | 签到方式 | String | |
time | 签到时间 | Int | |
supervise | 签到员 | String |
room_sigin
Title | Description | Type | Tips |
---|---|---|---|
id | 签到记录ID | Int | |
room | 签到地点 | String | |
mode | 签到方式 | String | |
time | 签到时间 | Int | |
supervise | 签到员 | String |
tags
Title | Description | Type | Tips |
---|---|---|---|
id | 签到记录ID | Int | |
name | 签到地点 | String | |
value | 签到方式 | String |
rooms
Title | Description | Type | Tips |
---|---|---|---|
id | 签到记录ID | Int | |
name | 签到地点 | String | |
label | 签到方式 | String | |
type | 展厅数字类型 | int | |
start_time | 展厅开始时间 | String | |
end_time | 展厅结束时间 | String | |
allow_entry | 是否允许参加 | bool | |
opening_time | 展厅运营时间区间 | String | |
hold_day | 展厅举办日 | String | |
is_active | 展厅是否启用 | String | |
cover_type | 展厅类型 | String | |
is_set_permission | 是否可以设置为权限 | bool | true 为 可设置 false 为不可 设置 |
own_attribute | 展示展厅描述信息 | String |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/04/26 | 李世星 | 新增 |
查看参与者的详细信息
GET_GUEST_INFO_OF_ACTIVITY
获取相关用户信息
GET
: /api/activity/{activity_id}/guest/{uuid} --header 'Bearer token'Response Body :
{
"status": 0,
"data": {
"uuid": "d5eeda0d517c426898671e62cdbf5592",
"order_num": "4294967295",
"name": "测试111",
"phone": 13342277828,
"company": "集微网1",
"position": "开发1",
"type": {
"id": 2,
"name": "vip",
"label": "VIP",
"color": "#FFFFFF"
},
"created_at": 1636015001,
"updated_at": 1635825651,
"place_sign": [
{
"id": 1,
"place": "签到处一",
"model": "扫码",
"time": 1634814251,
"supervise": "易初"
}
],
"room_sign": [
{
"id": 7,
"room": "默认展厅",
"model": "扫码",
"time": 1650571513,
"supervise": "易初"
}
],
"tags": [
{
"id": 21,
"name": "嘉宾类型",
"value": "普通嘉宾"
}
],
"room": [
{
"id": 6,
"name": "默认展厅6",
"label": "默认展厅",
"type": 1,
"status": 1,
"start_time": 1649658680,
"end_time": 1649831480,
"allow_entry": false,
"opening_time": "14:31-14:31",
"hold_day": "04月11日",
"is_active": true,
"cover_type": "普通展厅",
"is_set_permission": false,
"own_attribute": ""
}
]
}
}
HTTP Method
GET
HTTP Request
/api/activity/{activity_id}/guest/{uuid}
Request Parameters Query
Title | Description | Type | Required | Tips |
---|---|---|---|---|
uuid | 参会者唯一编码 | String | 36位唯一编码 |
Request Parameters Body
无
Response Data
guest Object
Title | Description | Type | Tips |
---|---|---|---|
uuid | 唯一凭证 | String | |
order_num | 订单号 | String | |
name | 参会者名称 | String | |
phone | 参会者手机号 | Int | |
company | 参会者所属公司 | String | |
position | 参会者职位 | String | |
type | 参会者类型 | type Object | |
created_at | 添加时间 | Int | |
updated_at | 修改时间 | String | |
place_sign | 参会者场馆签到记录 | Array | |
room_sign | 参会者展厅签到记录 | Array | |
tags | 附加信息 | Array | |
rooms | 参会者所能进入参会房间信息 | Array |
type
Title | Description | Type | Tips |
---|---|---|---|
id | TypeId | Int | |
name | 嘉宾类型名称 | String | |
label | 嘉宾类型标识 | String | |
color | 嘉宾类型颜色 | String | #FFFF |
place_sign
Title | Description | Type | Tips |
---|---|---|---|
id | 签到记录ID | Int | |
place | 签到地点 | String | |
mode | 签到方式 | String | |
time | 签到时间 | Int | |
supervise | 签到员 | String |
room_sigin
Title | Description | Type | Tips |
---|---|---|---|
id | 签到记录ID | Int | |
room | 签到地点 | String | |
mode | 签到方式 | String | |
time | 签到时间 | Int | |
supervise | 签到员 | String |
tags
Title | Description | Type | Tips |
---|---|---|---|
id | 签到记录ID | Int | |
name | 签到地点 | String | |
value | 签到方式 | String |
rooms
Title | Description | Type | Tips |
---|---|---|---|
id | 签到记录ID | Int | |
name | 签到地点 | String | |
label | 签到方式 | String | |
type | 展厅数字类型 | int | |
start_time | 展厅开始时间 | String | |
end_time | 展厅结束时间 | String | |
allow_entry | 是否允许参加 | bool | |
opening_time | 展厅运营时间区间 | String | |
hold_day | 展厅举办日 | String | |
is_active | 展厅是否启用 | String | |
cover_type | 展厅类型 | String | |
is_set_permission | 是否可以设置为权限 | bool | true 为 可设置 false 为不可 设置 |
own_attribute | 展示展厅描述信息 | String |
自定义对象
Log
日期 | 作者 | 内容 |
---|---|---|
2022/04/26 | 李世星 | 新增 |
工作人员管理
工作人员列表
GET_MANAGE_LIST_OF_ACTIVITY
工作人员列表
--Header
: token: Bearer {token}
GET
: /api/activity/23/manager?page=1&limit=1&search=13333891144Response Body:
{
"status": 0,
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 4,
"data": [
{
"id": 9,
"account": "测试222",
"phone": "17822222222",
"job": "",
"roles": [
{
"id": 1,
"label": "pc管理员A"
},
{
"id": 2,
"label": "android管理员"
},
{
"id": 3,
"label": "机器管理员"
}
],
"created_at": 1650608942,
"updated_at": 1650608953
},
{
"id": 8,
"account": "jjssss",
"phone": "13599999999",
"job": "test",
"roles": [
{
"id": 2,
"label": "android管理员"
},
{
"id": 13,
"label": "test label"
}
],
"created_at": 1650531510,
"updated_at": 1650608433
},
{
"id": 7,
"account": "测试twst11",
"phone": "17222222222",
"job": "1222",
"roles": [],
"created_at": 1650529367,
"updated_at": 1650531248
},
{
"id": 6,
"account": "test11",
"phone": "18922222222",
"job": "12",
"roles": [],
"created_at": 1650527786,
"updated_at": 1650527786
}
]
}
HTTP Method
GET
HTTP Request
/api/activity/{activity_id}/manager
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
page | 页数 | string | 否 | 活动页数 |
limit | 条数 | string | 否 | 条数,默认20 |
search | 姓名或手机号 | string | 否 | 搜索条件 |
Request Parameters Body
无
Response Data
Manager Object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 返回数据 | Object | |
data.id | manager ID |
Number | |
data.account | 姓名 | String | |
data.phone | 手机号 | String | |
data.job | 职务 | String | |
data.roles | 角色 | Array | |
data.created_at | 创建时间 | Number | |
data.updated_at | 修改时间 | Number |
Role Object
Title | Description | Type | Tips |
---|---|---|---|
id | Role ID |
Number | |
label | 角色名称 | String |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
新建用户
ADD_MANAGE_INFO_OF_ACTIVITY
新增工作人员
--Header
: token: Bearer {token}
GET
: /api/activity/67/managerRequest Body:
{
"account":"lixd",
"password":"123456",
"job":"开发",
"phone":"13333891144"
}
Response Body:
{
"status": 0
}
HTTP Method
POST
HTTP Request
/api/activity/{activity_id}/manager
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
account | 账号 | string | 是 | |
password | 密码 | string | 是 | |
job | 职务 | string | 否 | |
phone | 手机号 | string | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
编辑用户
MODIFY_MANAGE_INFO
编辑工作人员
--Header
: token: Bearer {token}
PUT
: /api/manager/5Request Body:
{
"account":"lixd",
"job":"技术部",
"phone":"13333891144"
}
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/manager/{manager_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
account | 账号 | string | 是 | |
job | 职务 | string | 否 | |
phone | 手机号 | string | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
删除用户
DEL_MANAGE_INFO
删除工作人员
--Header
: token: Bearer {token}
DELETE
: /api/manager/5Response Body:
{
"status": 0
}
HTTP Method
DELETE
HTTP Request
/api/manager/{manager_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
重置密码
RESET_MANAGER_PASSWORD
重置工作人员密码
--Header
: token: Bearer {token}
PUT
: /api/manager/reset/pwd/3Request Body:
{
"password": 123123,
"confirm_password": 123123
}
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/manager/reset/pwd/{manager_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
password | 新密码 | String | 是 | |
confirm_password | 确认密码 | string | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
角色配置
SET_ROLE_OF_MANAGER
给工作人员配置角色
--Header
: token: Bearer {token}
PUT
: /api/manager/3/roleRequest Body:
{
"roles":"1,2,3"
}
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/manager/{manager_id}/role
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
roles | 角色ids | String | 是 | 多个角色通过“,”分割 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
下载导出模板
DOWNLOAD_MANAGER_EXCEL_TEMPLATE_OF_ACTION
下载导入名单模板
--Header
: token: Bearer {token}
PUT
: /api/activity/{activity_id}/manager/excel-templateRequest Body:
Response Body:
HTTP Method
GET
HTTP Request
/api/activity/{activity_id}/manager/excel-template
Request Parameters Query
无
Request Parameters Body
无
Response Data
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/28 | 李世星 | 新增 |
批量导入
IMPORT_MANAGER_INFO_OF_ACTIVITY
批量导入管理员
--Header
: token: Bearer {token}
POST
: /api/activity/23/manager/import --form 'file=@C:\Users\admin\Desktop\导入管理员信息.xlsx'Request Body:
Response Body:
HTTP Method
POST
HTTP Request
/api/activity/23/manager/import
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 成功返回信息 | String |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/28 | 李世星 | 新增 |
角色管理
角色列表
GET_ROLE_LIST_OF_ACTIVITY
获取会议下的角色列表
--Header
: token: Bearer {token}
GET
: /api/activity/23/role?page=1&limit=1&search=and&query_all=1Response Body:
{
"status": 0,
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 2,
"data": [
{
"id": 2,
"name": "android_manager",
"label": "android管理员",
"created_at": "2022-04-11 18:13:30"
},
{
"id": 1,
"name": "pc_manager",
"label": "pc管理员A",
"created_at": "2022-04-11 18:00:38"
}
]
}
{
"status": 0,
"data": [
{
"id": 1,
"label": "pc管理员A",
"name": "pc_manager",
"is_default": true
},
{
"id": 2,
"label": "android管理员",
"name": "android_manager",
"is_default": false
},
{
"id": 3,
"label": "机器管理员",
"name": "robot_manager",
"is_default": false
},
{
"id": 4,
"label": "pc管理员B",
"name": "pc_manager",
"is_default": false
},
{
"id": 11,
"label": "1122",
"name": "122",
"is_default": false
},
{
"id": 12,
"label": "sad",
"name": "sad",
"is_default": false
},
{
"id": 13,
"label": "test label",
"name": "test role",
"is_default": false
}
]
}
HTTP Method
GET
HTTP Request
/api/activity/{activity_id}/role
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
page | 页数 | string | 否 | 活动页数 |
limit | 条数 | string | 否 | 条数,默认20 |
search | 角色名称 | string | 否 | 搜索条件 |
query_all | 获取全部数据 | string | 否 | 获取全部数据 |
Request Parameters Body
无
Response Data
具有分页属性的 Roles Object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
current_page | 当前页 | Number | |
last_page | 最后页 | Number | |
per_page | 每页条数 | Number | |
total | 总数 | Number | |
data | 返回数据 | Object | |
data.id | 用户id | Number | |
data.name | 角色名 | String | |
data.label | 角色标识 | String | |
data.created_at | 添加时间 | String |
全部数据的 Roles Object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 返回数据 | Object | |
data.id | 用户id | Number | |
data.name | 角色名 | String | |
data.label | 角色标识 | String | |
data.is_default | 是否是默认属性 | Bool |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
新增角色
ADD_ROLE_INFO_OF_ACTIVITY
在会议下的添加角色
--Header
: token: Bearer {token}
POST
: /api/activity/23/role?page=1&limit=1&search=andRequest Body:
{
"name":"test role",
"label":"test label",
"power": "11,12"
}
Response Body:
{
"status": 0
}
HTTP Method
POST
HTTP Request
/api/activity/{activity_id}/role
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
name | 角色名称 | String | 是 | |
label | 角色描述 | String | 是 | |
power | 权限 | String | 是 | 多个权限“,”分割 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
设备管理
设备列表
GET_DEVICE_LIST
在会议下查询设备
--Header
: token: Bearer {token}
GET
: /api/activity/1/deviceResponse Body:
{
"status": 0,
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 2,
"data": [
{
"id": 33,
"name": "d333a",
"label": "nubia",
"intro": "NX659J_CNCommon_V9.40",
"created_at": "2022-04-26T09:18:00.000000Z",
"phone": "18434819907",
"lasted_at": "2022-04-28 10:40:34",
"synced_at": null,
"push_at": null,
"status": 1
},
]
}
HTTP Method
GET
HTTP Request
/api/activity/{activity_id}/device
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
page | 页数 | string | 否 | 活动页数 |
limit | 条数 | string | 否 | 条数,默认20 |
search | 手机号 | string | 否 | 搜索条件 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
current_page | 当前页 | Number | |
last_page | 最后页 | Number | |
per_page | 每页条数 | Number | |
total | 总数 | Number | |
data | 返回数据 | Object |
Data Object
Title | Description | Type | Tips |
---|---|---|---|
id | 设备ID | Number | |
name | 设备号 | String | |
label | 设备名称|品牌 | String | |
intro | 设备型号 | String | |
created_at | 创建时间 | String | |
phone | 最后登陆账号 | String | |
lasted_at | 最后登陆时间 | String | |
synced_at | 最后同步时间 | String | |
push_at | 最后提交数据时间 | String | |
status | 当前状态 0-已删除 1-登陆中 2-已退出 可强制退出为(1-登陆中) | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/29 | 朱思嘉 | 新增 |
2022/5/13 | 李晓东 | 修改最后提交时间字段 |
强制下线
MODIFY_USERINFO_ACTIVITY
强制下线
--Header
: token: Bearer {token}
PUT
: /api/activity/1/deviceResponse Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/activity/{activity_id}/device
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
device_id | 设备ID | string | 是 | 设备ID |
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/29 | 朱思嘉 | 新增 |
账号管理
账号列表
GET_USER_LIST
获取后台账号列表
--Header
: token: Bearer {token}
GET
: /api/user?search=奥德赛&limit=20&page=1Response Body:
{
"status": 0,
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 1,
"data": [
{
"id": 5,
"account": "",
"phone": "17898890678",
"department": "市场部",
"job": "专员",
"created_at": 1649903809
}
]
}
HTTP Method
GET
HTTP Request
/api/user
Request Parameters Query
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
page | 页数 | string | 否 | 活动页数 |
limit | 条数 | string | 否 | 条数,默认20 |
search | 活动名称 | string | 否 | 搜索条件 |
Request Parameters Body
无
Response Data
User Object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
current_page | 当前页 | Number | |
last_page | 最后页 | Number | |
per_page | 每页条数 | Number | |
total | 总数 | Number | |
data | 返回数据 | Object | |
data.id | 用户id | Number | |
data.account | 用户账号 | String | |
data.phone | 用户手机号 | String | |
data.department | 部门 | String | |
data.job | 职位 | String | |
data.created_at | 创建时间 | String |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
新增账号
ADD_USER_INFO
新增后台账号
--Header
: token: Bearer {token}
POST
: /api/userRequest Body:
{
"account":"账号",
"password":123456,
"phone":15762338890,
"department":"技术部",
"job":"开发"
}
Response Body:
{
"status": 0
}
HTTP Method
POST
HTTP Request
/api/user
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
account | 账号 | string | 是 | |
password | 密码 | String | 是 | |
phone | 手机号 | String | 是 | |
department | 部门 | string | 否 | |
job | 职位 | string | 否 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
编辑账号
MODIFY_USER_INFO
编辑后台账号
--Header
: token: Bearer {token}
PUT
: /api/user/{user_id}Request Body:
{
"account":"账号",
"phone":15762338890,
"department":"技术部",
"job":"开发"
}
Response Body:
{
"status": 0
}
HTTP Method
PUT
HTTP Request
/api/user/{user_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
account | 账号 | string | 是 | |
phone | 手机号 | String | 是 | |
department | 部门 | string | 否 | |
job | 职位 | string | 否 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
获取账号详情
GET_USER_INFO
获取账号详情
--Header
: token: Bearer {token}
GET
: /api/user/{user_id}Response Body:
{
"status": 0,
"data": {
"id": 7,
"account": "账号",
"phone": "15762338890",
"department": "技术部",
"job": "开发",
"created_at": 1650436417
}
}
HTTP Method
GET
HTTP Request
/api/user/{user_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
User Info object
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number | |
data | 返回数据 | Object | |
data.id | 用户id | Number | |
data.account | 账号 | String | |
data.phone | 手机号 | String | |
data.department | 部门 | String | |
data.job | 职位 | String | |
data.created_at | 注册时间 | String |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
重置账号密码
RESET_USER_PASSWORD
重置用户密码
--Header
: token: Bearer {token}
PUT
: /api/user/reset/pwd/{user_id}Request Body:
{
"password": 123123,
"confirm_password": 123123
}
HTTP Method
PUT
HTTP Request
/api/user/reset/pwd/{user_id}
Request Parameters Query
无
Request Parameters Body
Parameter | Description | Type | Required | Explain |
---|---|---|---|---|
password | 新密码 | String | 是 | |
confirm_password | 确认密码 | string | 是 |
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
删除账号
DEL_USER_INFO
删除账号
--Header
: token: Bearer {token}
DELETE
: /api/user/{user_id}Response Body:
{
"status": 0
}
HTTP Method
DELETE
HTTP Request
/api/user/{user_id}
Request Parameters Query
无
Request Parameters Body
无
Response Data
Title | Description | Type | Tips |
---|---|---|---|
status | code 0为成功 | Number |
Log
日期 | 作者 | 内容 |
---|---|---|
2022/4/19 | 李晓东 | 新增 |
文档使用帮助
在index.html.md
文件中进行编辑目录和文档总体结构,然后在includes目录中添加对应的模块。
文档使用Markdown语言排版。
Markdown格式示例
# 标题
## 二级标题
### .......
``` json
代码块
```
表格
表头 | 表头
---------- | -------
内容 | 内容
内容 | 内容
`Something`
表格
表头 | 表头 |
---|---|
内容 | 内容 |
内容 | 内容 |
无序列表😄
无序列表😜
Json
是没有注释的 避免在json中写注释
Something
高亮
加粗 粗体
横线
下划线
斜体