NAV
json

ACP API WIKI 文档

Activity Checkin Platform 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有效期

访问需要鉴权的接口共需要两步:

  1. 判断当前Token是否存在或过期，若有异常则重新通过登录授权接口获取Token 。（通过账号密码进行验证，移动端额外需要设备唯一标识传至头部信息）
  2. 在Http Header中携带已保存的Token。
  3. 头部信息描述 key为Authorization value为登陆接口返回的Token。

接口返回说明

第一层 http code返回码，目前常见返回码如下

Http code 说明
200 调用成功
400 调用失败，返回自定义错误
401 鉴权失败
403 权限不足，没有调用权限
500 服务器本身出错

第二层 接口返回内容中的status和error字段

对于status,我们有如下规定

错误说明

error（针对于APP端）

为字符串，会给出status的具体错误原因描述，可信赖字段，可直接展示至前端页面

errors (针对于PC端 用于表单验证)

为一个对象，会给出status的具体错误原因描述，这个字段适用于程序开发中的错误调试，不应该把他的返回内容作为代码逻辑判断的条件。也不应直接在前端页面显示。

示例

{
    "status": 1,
    "errors": {
        "account": " account 不能为空",
        "code": " code 不能为空"
    }
}

接口地址说明

http https
线下 http://47.107.239.240:8281
预发布
正式 http://120.25.235.220:8281

系统鉴权

获取Bearer Token

GET_BEARER_TOKEN

获取系统中所使用的token

POST: /api/access/token

--header 'Content-Type: application/json'

--data-raw: json ```json

{ "code": "d3c7e82e", "place_id":1, "account":"13333891144", "password":"123456" } ```

Request Body:

{
  "code": "d3c7e82e",
  "place_id":1,
  "account":"13333891144",
  "password":"123456"
}

Response Body :

{
  "status": 0,
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImFjcF9hcGkifQ.eyJjb2RlIjoiZDNjN2U4MmUiLCJhdWQiOiIxIiwiaXNzIjoiYWNwLWFwaSIsInN1YiI6ImFjcC1iZXRhLXVzZXIiLCJpYXQiOjE2MzU4MjQ1NTUsImV4cCI6MTYzNTkxMDk1NX0.-5F9c-xoW6sjTDdVZxWUNhtSmicYW7A6DWuZG56y9Mk",
  "token_method": "HS256",
  "token_type": "Bearer",
  "expire_time": 1635910955
}

Token Payload:

{
    "code": "d3c7e82e",
    "aud": 2,
    "place": 1,
    "iss": "acp-api",
    "sub": "acp_web_pc",
    "iat": 1573116338,
    "exp": 1573119938,
    "is_edit": true
}

HTTP Method

POST

HTTP Request

/api/access/token

Request Parameters Query

无

Request Parameters Body

Title Description Type Tips
code 签到系统的活动唯一凭证（未登录时使用） String 8位16进制字符用于路由 beta版本默认为d3c7e82e
place 签到场地ID Int 登录页面初始化前 使用 code 获取签到场地信息
account 账号 String 管理员手机号登录 13333891144
password 密码 String 默认123456

Response Data

Title Description Type Tips
status int 状态 0 正常 1为失败
token string token字符串
token_method string 加密方式
token_type string token 的类型，目前应该固定为 Bearer
expire_time int 过期时间
is_edit Bool 是否可以开启编辑 false 为不可编辑 true 可编辑

Payload

Title Description Type Tips
code string 活动唯一凭证
aud int 用户id
place int 场地id
iss string 颁发方
sub int 使用方
iat int 颁发时间
exp int 过期时间

Log

日期 作者 内容
2021/10/13 易初 新增
2021/11/2 李星星 修改
2022/04/24 李星星 修改 增加place 场地
2022/04/26 李星星 修改 登录使用管理员手机号

权限

权限菜单

获取权限menu列表

获取权限menu列表

GET: /api/menu --header 'Bearer token'

Response Body :

{
  "status": 0,
  "data": [
    {
      "id": 1,
      "icon": "",
      "name": "报名列表",
      "link": "list"
    },
    {
      "id": 2,
      "icon": "",
      "name": "创建报名",
      "link": "creater"
    },
    {
      "id": 3,
      "icon": "",
      "name": "扫码签到",
      "link": "scan"
    },
    {
      "id": 4,
      "icon": "",
      "name": "统计",
      "link": "total"
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/menu/

Request Parameters Query

无

Request Parameters Body

无

Response Data

data

Title Description Type Tips
id 菜单id Int
name 菜单名字 String
icon 前端按钮图标 String
link 前端路由 String

Log

日期 作者 内容
2021/11/22 李世星 新增
2022/04/11 李世星 更改

会展签到活动

根据code获取签到活动的场地信息列表

GET_CHECKIN_PLACE_OF_ACTIIVITY

获取当前活动唯一凭证的系统的全部可使用的场地

GET: /api/place?code=d3c7e82e

Response Body :

{
    "status": 0,
    "data": [
        {
            "id": 1,
            "name": "会场一",
            "label": "默认签到处"
        }
    ]
}

HTTP Method

GET

HTTP Request

/api/place

Request Parameters Query

Parameter Description Type Required Explain
code 活动唯一凭证 string 是 活动唯一凭证，beta版本为d3c7e82e

Request Parameters Body

无

Response Data

Checkin Place Object

Title Description Type Tips
id Place ID Int
name 签到场地名称 String
label 场地注解 String

Log

日期 作者 内容
2021/10/13 易初 新增

根据code获取活动相关信息

GET_CHECKIN_ACTIVITY_INFO

获取当前活动的详情信息

GET: /api/activity/{sync_code}

Success Response Body :

{
  "status": 0,
  "data": {
    "uuid": "d3c7e82e",
    "name": "CarMeetingCheckin",
    "label": "汽车峰会签到",
    "start_time": 1633943483,
    "end_time": 1643706687,
    "status": 1
  }
}

Error Response Body :

{
  "status": 1,
  "error": "非法code"
}

HTTP Method

GET

HTTP Request

/api/activity/{sync_code}

Request Parameters Body

无

Response Data

Checkin Activity Object

Title Description Type Tips
uuid 活动唯一code码 String
name 签到场地名称 String
label 场地注解 String
start_time 活动开始时间 Int
end_time 活动结束时间 Int
status 活动状态 Int 0代表活动结束1代表活动正在进行中

Log

日期 作者 内容
2021/12/13 李世星 新增

获取活动列表

GET_CHECKIN_ACTIVITY_LIST

获取当前活动的详情信息

GET: /api/activity

Response Body :

{
  "status": 0,
  "data": [
    {
      "uuid": "d3c7e82e",
      "name": "CarMeetingCheckin",
      "label": "汽车峰会签到",
      "start_time": 1633943483,
      "end_time": 1643706687,
      "status": 1
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/activity

Request Parameters Body

Title Description Type Required Tips
vague 搜索全部(名称、标签) String 否
name 名称 String 否
label 标签 String 否

Response Data

Checkin Activity ListData

Title Description Type Tips
uuid 活动唯一code码 String
name 签到场地名称 String
label 场地注解 String
start_time 活动开始时间 Int
end_time 活动结束时间 Int
status 活动状态 Int 0代表活动结束1代表活动正在进行中

Log

日期 作者 内容
2021/12/13 李世星 新增

扫码验票签到

签到验票接口

ADD_CHECKIN_LOG_TO_GUSET

签到并获取相关用户信息

POST: /api/guest/{uuid}/checkin_log?type=1 --header 'Bearer token'

Response Body :

{
  "status": 0,
  "sign": {
    "id": 13,
    "place": "签到处一",
    "model": "手动",
    "time": 1635843727,
    "supervise": "guest1",
    "rq_link": "http://xxxxxx.com/?uuid=f22s5599988745"
  }
}

HTTP Method

POST

HTTP Request

/api/guest/{uuid}/checkin_log

Request Parameters Query

Title Description Type Required Tips
type 签到类型 1 为扫码 2为手动 否 默认扫码签到

Request Parameters Body

无

Response Data

Title Description Type Tips
sign 签到记录 Array

sign_Item Object

Title Description Type Tips
id 签到记录ID Int
place 签到地点 String
mode 签到方式 String
time 签到时间 Int
supervise 签到员 String
rq_link 签到成功返回打印数据 String

Log

日期 作者 内容
2021/10/14 李世星 新增
2021/11/2 李世星 修改
2021/05/06 李世星 修改

参与人员信息

获取参与者数据的列表

GET_ACTIVITY_GUEST_LIST

获取本次活动对应的参会人员数据列表

GET: /api/guest --header 'Bearer token'

Resquest params : /api/guest?order_num=&vague=&name=&phone=&company=&type=&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,
      "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": ""
        }
      ],
      "qr_link": "http://xxx.com/?uuid=28825d2a-3307-11ec-8961-0242c0a83002"
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/guest

Request Parameters Query

Title Description Type Required Tips
order_num 订单号 String 否
vague 搜索全部(包含名称手机号公司) String 否
name 名称 String 否
phone 手机号 Int 否
company 公司 String 否
type 客户类型 String 否 all 为全部搜索 传入用户类型ID
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
type 参会者类型 type Object
created_at 添加时间 Int
place_sign 参会者场馆签到记录 Array
room_sign 参会者展厅签到记录 Array
tags 附加信息 Array
rooms 参会者所能进入参会房间信息 Array
rq_link 参会嘉宾二维码链接 String

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

日期 作者 内容
2021/10/14 李世星 新增
2021/10/18 谢宇轩 修改API_NAME
2021/10/22 谢宇轩 修改查询的条件
2021/11/2 李世星 修改返回参数
2022/04/24 李世星 修改返回参数和请求参数

查看参与者的详细信息

GET_ACTIVITY_GUEST_INFO

获取相关用户信息

GET: /api/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": ""
      }
    ],
    "rq_link": "http://xxxx.com/?uuid=d5eeda0d517c426898671e62cdbf5592"
  }
}

HTTP Method

GET

HTTP Request

/api/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
rq_link 参会嘉宾二维码链接 String

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

日期 作者 内容
2021/10/14 李世星 新增
2021/10/18 谢宇轩 修改API_NAME
2021/10/22 谢宇轩 新增接口描述
2021/11/2 李世星 修改返回参数
2022/04/22 李世星 修改返回参数 增加place_sign room_sign tags rooms

为签到活动新增参与者

ADD_GUEST_TO_ACTIVITY

新增活动一个参与者

POST: /api/guest --header 'Bearer token'

RequestBody:\ --header 'Content-Type: application/json' --data-raw:

{
  "order_num":"42949673001",
  "name":"李星星呀3",
  "phone":13333891144,
  "type": 1,
  "company":"爱集微",
  "position":"开发",
  "notes":[
    {"key": "是否参加校友会","value":"参加"}
  ],
  "rooms":{
    "86":{"extra":""},
    "96":{"extra":""},
    "97":{"extra":"主持人1"}
  },
  "auto_sign":1
}

RequestBody:

{
  "status": 0,
  "data": {
    "uuid": "c5fd753eebbf415f94f62a37445fdfd5",
    "order_num": 42949673001,
    "name": "李星星呀3",
    "phone": 13333891144,
    "company": "爱集微",
    "position": "开发",
    "type": {
      "id": 1,
      "name": "is_vip_fase",
      "label": "普通嘉宾",
      "color": "#FFFFFF"
    },
    "created_at": 1650511582,
    "updated_at": 1650511582,
    "place_sign": [],
    "room_sign": [],
    "tags": [
      {
        "id": 1,
        "name": "是否参加校友会",
        "value": "参加"
      }
    ],
    "room": [
      {
        "id": 6,
        "name": "默认展厅6",
        "label": "默认展厅",
        "type": 1,
        "status": 1,
        "start_time": 1649658680,
        "end_time": 1649831480,
        "allow_entry": true,
        "opening_time": "14:31-14:31",
        "hold_day": "04月11日",
        "is_active": true,
        "cover_type": "普通展厅",
        "is_set_permission": false,
        "own_attribute": ""
      }
    ]
  }
}

HTTP Method

POST

HTTP Request

/api/guest

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
name 参与者名称 String 是
phone 参与者手机 String 是
company 参与者公司 String 是
type 参与者类型 Int 是
position 参与者职务 String 否
order_num 订单号 String 否
notes 备注 array 否 [{"key":"是否参加校友会","value":"参加"}]
rooms 录入房间权限 array 否 勾选为展厅id集合 {"86":{"extra":""},"96":{"extra":""},"97":{"extra":"主持人1"}}
auto_sign 是否录入签到 Int 否 0 为录入后不签到 1 录入后自动签到 默认为录入后不签到

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
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

日期 作者 内容
2021/10/14 李世星 新增
2021/10/18 谢宇轩 修改API_NAME
2021/11/2 李世星 修改返回参数和新增 请求例
2022/04/22 李世星 修改请求和返回参数 增加 tags 和 room权限

修改某一位参与者的详细信息

UPDATE_GUEST_INFO

修改某位参与者详情信息

PUT: /api/guest/{uuid}

--header 'Bearer token'

--header 'Content-Type: application/json'

RequestBody:

{
    "name" : "李星星",
    "phone" : 13333891144,
    "company": "爱集微",
    "position" : "开发",
    "order_num": 4294967296,
    "type":1,
    "notes":[
      {"Key":"是否参加上汽","value":"参加"}
    ],
    "rooms":{
      "86":{"extra":""},
      "96":{"extra":""},
      "97":{"extra":"主持人1"}
    }
}

Response Body :

{
  "status": 0,
  "data": {
    "uuid": "bc62e3aaa90543309f4da662795a2dcf",
    "order_num": "4294967296",
    "name": "李星星1",
    "phone": 13333891144,
    "company": "爱集微",
    "position": "开发",
    "type": {
      "id": 1,
      "name": "is_vip_fase",
      "label": "普通嘉宾",
      "color": "#FFFFFF"
    },
    "created_at": 1649401335,
    "updated_at": 1650437044,
    "place_sign": [],
    "room_sign": [],
    "tags": [
      {
        "id": 44,
        "name": "是否参加上汽",
        "value": "参加"
      },
      {
        "id": 45,
        "name": "霍霍你",
        "value": "来吧"
      }
    ],
    "room": [
      {
        "id": 6,
        "name": "默认展厅6",
        "label": "默认展厅",
        "type": 1,
        "status": 1,
        "start_time": 1649658680,
        "end_time": 1649831480,
        "allow_entry": true,
        "opening_time": "14:31-14:31",
        "hold_day": "04月11日",
        "is_active": true,
        "cover_type": "普通展厅",
        "is_set_permission": false,
        "own_attribute": ""
      }
    ]
  }
}

HTTP Method

PUT

HTTP Request

/api/guest/{uuid}

Request Parameters Query

Title Description Type Required Tips
uuid 参与者uuid String 是

Request Parameters Body

Title Description Type Required Tips
name 参与者名称 String 否
phone 参与者手机 String 否
company 参与者公司 String 否
type 参与者类型 Int 否
position 参与者职务 String 否
order_num 订单号 String 否
notes 附加信息 array 否 [{"key":"是否参加上汽","value":"参加"}]
rooms 展厅权限 array 否 {"86":{"extra":""},"96":{"extra":""},"97":{"extra":"主持人1"}}

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 修改时间 Int
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/22 李世星 修改notes参数和返回参数

新增或修改参会者到签到系统（机器同步某位参与者到签到系统）

SAVE_GUEST_TO_GUEST

机器同步某位参与者到签到系统

PUT: /api/guest HTTP/1.1

--header 'Bearer token'

--header 'Content-Type: application/json'

RequestBody:

{
  "name":"测试12345",
  "phone":"13333891142",
  "order_num": "21110867475403411",
  "company": "小小公司欢乐多",
  "position": "测试",
  "notes": [
    {"key":"是否参加上汽","value":"参加"}
  ],
  "type":1
}

Response Body :

{
  "status": 0,
  "data": {
    "uuid": "bc62e3aaa90543309f4da662795a2dcf",
    "order_num": "21110867475403411",
    "name": "测试12345",
    "phone": 13333891142,
    "company": "爱集微",
    "position": "开发",
    "type": {
      "id": 1,
      "name": "is_vip_fase",
      "label": "普通嘉宾",
      "color": "#FFFFFF"
    },
    "created_at": 1649401335,
    "updated_at": 1650437044,
    "place_sign": [],
    "room_sign": [],
    "tags": [
      {
        "id": 44,
        "name": "是否参加上汽",
        "value": "参加"
      },
      {
        "id": 45,
        "name": "霍霍你",
        "value": "来吧"
      }
    ],
    "room": [
      {
        "id": 6,
        "name": "默认展厅6",
        "label": "默认展厅",
        "type": 1,
        "status": 1,
        "start_time": 1649658680,
        "end_time": 1649831480,
        "allow_entry": true,
        "opening_time": "14:31-14:31",
        "hold_day": "04月11日",
        "is_active": true,
        "cover_type": "普通展厅",
        "is_set_permission": false,
        "own_attribute": ""
      }
    ]
  }
}

HTTP Method

PUT

HTTP Request

/api/guest

Request Parameters Query

无

Request Parameters Body

Title Description Type Required Tips
name 参与者名称 String 是
phone 参与者手机 String 是
company 参与者公司 String 否
type 参与者类型 Int 是
position 参与者职务 String 否
order_num 订单号 String 否
notes 备注 Array 否

guest Object

Title Description Type Tips
uuid 唯一凭证 String
order_num 订单号 String
name 参会者名称 String
phone 参会者手机号 Int
company 参会者所属公司 String
position 参会者职位 String
type 参会者类型 type Object
sign 签到记录 Array
created_at 添加时间 Int
updated_at 修改时间 Int
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

日期 作者 内容
2021/11/12 李世星 新增
2022/04/22 李世星 修改notes参数和返回参数

检索公司名称

GET_COMPANY_OF_TY_TOOL_LIST

检索公司名称

GET: /api/company/search HTTP/1.1

--header 'Bearer token'

RequestBody:

Response Body :

{
  "status": 0,
  "total": 0,
  "data": [
    {
      "name": "爱集微咨询（厦门）有限公司",
      "tax_number": "91350200MA2YC2UA52"
    },
    {
      "name": "爱集微信息技术（上海）有限公司",
      "tax_number": "91310115MA1K4K8A6M"
    },
    {
      "name": "北京集微科技有限公司",
      "tax_number": "91110108MA01ALL62Q"
    },
    {
      "name": "深圳市嘉德知识产权服务有限公司",
      "tax_number": "91440300335145586J"
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/company/search

Request Parameters Query

Title Description Type Required Tips
company_name 公司名称 String 是

Request Parameters Body

data Object

Title Description Type Tips
name 公司名称 String
tax_number 公司编码 String

Log

| 日期 | 作者 | 内容 | | 2022/04/28 | 李世星 | 新增|

获取统计列表页嘉宾信息

GET_REPORT_GUEST_LIST

检索公司名称

GET: /api/guest/report_guest HTTP/1.1

--header 'Bearer token'

RequestBody:

Response Body :

{
  "status": 0,
  "current_page": 1,
  "last_page": 7,
  "per_page": 20,
  "total": 139,
  "data": [
    {
      "uuid": "d2ba6839132f33db995ee73476722694",
      "order_num": "220617521637681620",
      "name": "赖爱华",
      "phone": 15747969474,
      "company": "黄石金承科技有限公司",
      "position": "教授",
      "type": {
        "id": 1,
        "name": "is_vip_fase",
        "label": "普通嘉宾",
        "color": "#FFFFFF"
      },
      "created_at": 1655452163,
      "tags": []
    },
    {
      "uuid": "f4425dd343363932a2034064780e62a9",
      "order_num": "220617513731140467",
      "name": "翟欢",
      "phone": 15283101121,
      "company": "恩悌网络有限公司",
      "position": "女士",
      "type": {
        "id": 1,
        "name": "is_vip_fase",
        "label": "普通嘉宾",
        "color": "#FFFFFF"
      },
      "created_at": 1655451373,
      "tags": []
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/guest/report_guest

Request Parameters Query

Title Description Type Required Tips
room_id 会议展厅房间id Int 否
sign_status 签到状态 Int 否 0为未签 1已签 不填为全部
place_id 场馆id Int 否
type_id 嘉宾类型id Int 否
limit 每页数据 Int 否 默认20 limit -1时，获取全部数据，不进行分页
page 当前页 Int 否 默认1

Request Parameters Body

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
place_sign 参会者场馆签到记录 Array
room_sign 参会者展厅签到记录 Array
tags 附加信息 Array
rooms 参会者所能进入参会房间信息 Array
rq_link 参会嘉宾二维码链接 String

type

Title Description Type Tips
id TypeId Int
name 嘉宾类型名称 String
label 嘉宾类型标识 String
color 嘉宾类型颜色 String #FFFF

tags

Title Description Type Tips
id 签到记录ID Int
name 签到地点 String
value 签到方式 String

Log

| 日期 | 作者 | 内容 | | 2022/06/29 | 李世星 | 新增|

系统数据分析与汇报

基于参与者类型的签到情况分析信息接口

REPORT_FROM_PARTICIPATE_TYPE

获取当前活动的分析结果

GET: /api/report/guest_type --header 'Bearer token'

Response Body :

{
    "status": 0,
    "data": {
      "list": [
        {
          "type_id": 1,
          "name": "default",
          "label": "普通嘉宾",
          "color": "#FFFFFF",
          "background_color": "FFFFFF",
          "has_checkin": 100,
          "un_checkin": 64,
          "total":164,
          "checkin_rate": 60
        },
        {
          "type_id": 2,
          "name": "vip",
          "label": "VIP",
          "color": "#FFFFFF",
          "background_color": "FFFFFF",
          "has_checkin":23,
          "un_checkin":6,
          "total":29,
          "checkin_rate": 79
        }
      ],
      "total": {
        "color": "#FFFFFF",
        "background_color": "FFFFFF",
        "has_checkin":123,
        "un_checkin":70,
        "total":193,
        "checkin_rate": 64
      }
    }
}

HTTP Method

GET

HTTP Request

/api/report/guest_type

Request Parameters Query

无

Request Parameters Body

无

Response Data

Title Description Type Tips
list 列表数据 list Object
total 总计数据 total Object

list Object

Title Description Type Tips
type_id Type ID Int
name 类型名称 String
label 类型注解 String
has_checkin 签到数量 Int
un_checkin 未签到数量 Int
color 字体颜色 String #FFFFF
background_color 背景颜色 String #FFFFFF
total 总计 Int
checkin_rate 签到率 Int 百分之 30

total Object

Title Description Type Tips
color 字体颜色 String #FFFFF
background_color 背景颜色 String #FFFFFF
has_checkin 签到数量 Int
un_checkin 未签到数量 Int
total 总计 Int
checkin_rate 签到率 Int 百分之 30

Log

日期 作者 内容
2021/10/13 易初 新增
2021/11/5 李世星 修改统计参数 签到率

基于参与者权限的签到情况分析信息接口

REPORT_FROM_PARTICIPATE_PERMISSION

获取当前活动的分析结果

GET: /api/report/guest_permission --header 'Bearer token'

Response Body :

{
  "status": 0,
  "data": {
    "alumni_forun": [],
    "ordinary_room": [
      {
        "id": 260,
        "name": "三山五岳",
        "label": "集微半导体分析师大会",
        "type": 2,
        "total": 12,
        "sign_num": 2,
        "un_sign_num": 10,
        "checkin_rate": 17,
        "color": "#FFFFFF",
        "background_color": "#ccafcd"
      },
      {
        "id": 261,
        "name": "药王谷",
        "label": "第四届中国“芯力量”评选活动",
        "type": 3,
        "total": 9,
        "sign_num": 2,
        "un_sign_num": 7,
        "checkin_rate": 22,
        "color": "#FFFFFF",
        "background_color": "#ccafcd"
      }
    ]
  }
}

HTTP Method

GET

HTTP Request

/api/report/guest_permission

Request Parameters Query

无

Request Parameters Body

无

Response Data

Title Description Type Tips
id ID Int
alumni_forun 校友论坛 Array
ordinary_room 非校友论坛 Array

data Array

Title Description Type Tips
id ID Int
name 展厅名称 String
label 展厅label String
total 总人数 Int
sign_num 签到数 Int
un_sign_num 未签到 Int
checkin_rate 签到率 String
background_color 背景颜色 String #ccafcd
color 字体颜色 String #FFFFF

Log

日期 作者 内容
2021/10/14 李世星 新增
2022/4/28 李世星 修改参数下发

基于参与者签到场地的签到情况分析信息接口

REPORT_FROM_PARTICIPATE_PLACE

获取当前活动的分析结果

GET: /api/report/guest_place --header 'Bearer token'

{
    "status": 0,
    "data": {
      "list": [
        {
          "color": "#FFFFFF",
          "background_color": "FFFFFF",
          "place_id": 2,
          "place_label": "24日华邑签到",
          "place_guest_total": 655,
          "has_checkin": 654,
          "un_checkin": 1,
          "checkin_rate": 99
        },
        {
          "color": "#FFFFFF",
          "background_color": "FFFFFF",
          "place_id": 3,
          "place_label": "25日华邑签到",
          "place_guest_total": 352,
          "has_checkin": 352,
          "un_checkin": 0,
          "checkin_rate": 100
        }
      ],
      "total":{
        "color": "#FFFFFF",
        "background_color": "FFFFFF",
        "total": 1006
      }
    }
}

HTTP Method

GET

HTTP Request

/api/report/guest_place

Request Parameters Query

Request Parameters Body

无

Response Data

Title Description Type Tips
list 场地统计列表 Array
total 总计数据 total Object

list Object

Title Description Type Tips
color 字体颜色 String #FFFFF
background_color 背景颜色 String #FFFFFF
place_id 场地ID Int
place_label 场地名称 String
place_guest_total 场地签到总人数 int
has_checkin 签到人数 int
un_checkin 未签到人数 int
checkin_rate 签到率 float

total Object

Title Description Type Tips
color 字体颜色 String #FFFFF
background_color 背景颜色 String #FFFFFF
total 总计 Int

Log

日期 作者 内容
2021/10/14 李世星 新增

系统中静态和表单资源

获取查询表单的条件

FORM_CONDITION_OF_GUEST

获取查询表单的条件

GET: /api/resource/condition --header 'Bearer token'

{
  "status": 0,
  "data": [
    {
      "type": "relevant",
      "input_type": "select_input",
      "type_name": "",
      "options": [
        {
          "id": 1,
          "label": "全选",
          "name": "vague",
          "type": "relevant",
          "type_name": "",
          "input_type": "select_input",
          "color": "#FFFFFF",
          "is_active": true
        },
        {
          "id": 2,
          "label": "手机",
          "name": "phone",
          "type": "relevant",
          "type_name": "",
          "input_type": "select_input",
          "color": "#FFFFFF",
          "is_active": false
        },
        {
          "id": 3,
          "label": "姓名",
          "name": "name",
          "type": "relevant",
          "type_name": "",
          "input_type": "select_input",
          "color": "#FFFFFF",
          "is_active": false
        },
        {
          "id": 4,
          "label": "公司",
          "name": "company",
          "type": "relevant",
          "type_name": "",
          "input_type": "select_input",
          "color": "#FFFFFF",
          "is_active": false
        }
      ]
    },
    {
      "type": "status",
      "input_type": "select",
      "type_name": "签到状态",
      "options": [
        {
          "id": 8,
          "label": "全选",
          "name": "all",
          "type": "status",
          "type_name": "签到状态",
          "input_type": "select",
          "color": "#FFFFFF",
          "is_active": true
        },
        {
          "id": 9,
          "label": "已签到",
          "name": "has_checkin",
          "type": "status",
          "type_name": "签到状态",
          "input_type": "select",
          "color": "#FFFFFF",
          "is_active": false
        },
        {
          "id": 10,
          "label": "未签到",
          "name": "un_checkin",
          "type": "status",
          "type_name": "签到状态",
          "input_type": "select",
          "color": "#FFFFFF",
          "is_active": false
        }
      ]
    },
    {
      "type": "type",
      "input_type": "select",
      "type_name": "嘉宾类型",
      "options": [
        {
          "id": 11,
          "label": "全选",
          "name": "all",
          "type": "type",
          "type_name": "嘉宾类型",
          "input_type": "select",
          "color": "#FFFFFF",
          "active": true
        },
        {
          "id": 12,
          "label": "普通嘉宾",
          "name": "1",
          "type": "type",
          "type_name": "嘉宾类型",
          "input_type": "select",
          "color": "#FFFFFF",
          "is_active": false
        },
        {
          "id": 13,
          "label": "VIP嘉宾",
          "name": "2",
          "type": "type",
          "type_name": "嘉宾类型",
          "input_type": "select",
          "color": "#FFFFFF",
          "is_active": false
        }
      ]
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/resource/condition

Request Parameters Query

Title Description Type Required Tips
token 登录后token标识码 String 是

Request Parameters Body

无

Response Data

data

Title Description Type Tips
type 表单提交类型 String relevant,status,type
type_name 表单提交类型名称 String `,签到状态,嘉宾类型`
input_type 选择框类型 String
options 选择框值 Array

options relevant Item

Title Description Type Tips
label 信息表单注释对应搜索选择框的名称 String
name 信息表单搜索选择框值 String
type 所属表单类型 String
input_type 选择框类型 String
color 标识型颜色 String
is_active 是否默认选中 Bool true 选中 false 未选中

options type Item

Title Description Type Tips
name 对应参会者Id 对应类型选择框的值 String
label 参会者类型表单注释 对应类型选择框的名称 String
type 所属表单类型 String
input_type 选择框类型 String
color 参会者类型颜色 String
is_active 是否默认选中 Bool true 选中 false 未选中

options status Item

Title Description Type Tips
name 签到状态表单状态 String
label 签到状态表单注释 String
type 所属表单类型 String
input_type 选择框类型 String
color 标识型颜色 String
is_active 是否默认选中 Bool true 选中 false 未选中

Log

日期 作者 内容
2021/10/14 李世星 新增
2021/10/18 谢宇轩 修改API_NAME和URL
2021/10/2 李世星 修改返回参数和注解
2022/04/22 李世星 修改返回参数和注解 增加下发类型和输入框类型

获取签到活动中参与人员的类型列表

GET_GUEST_TYPE_OF_ACTIIVITY

获取当前的系统中全部可使用的参与人员类型

GET: /api/resource/guest_type --header 'Bearer token'

{
    "status": 0,
    "data": [
        {
            "id": 1,
            "name": "vip",
            "label": "VIP",
            "color": "#FFFF"
        },
        {
            "id": 2,
            "name": "defalut",
            "label": "普通嘉宾",
            "color": "#FFFF"
        }
    ]
}

HTTP Method

GET

HTTP Request

/api/resource/guest_type

Request Parameters Query

无

Request Parameters Body

无

Response Data

Guest Type Object

Title Description Type Tips
id Type ID Int
name 类型名称 String
label 类型注解 String
color 颜色 #FFF String

Log

日期 作者 内容
2021/10/13 易初 新增
2021/10/18 谢宇轩 修改URL

手持签到设备

移动端登录（Mobile Bearer Token）

GET_MOBILE_BEARER_TOKEN

移动端APP登录

POST: /api/mobile/access/token

--header 'Content-Type: application/json'

--header 'User-Agent:xxxx'

Request Body:

{
    "code": "d3c7e82e",
    "account":"13342211111",
    "password":"123456"
}

Response Body :

{
    "status": 0,
    "data": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImFjcF9hcGkifQ.eyJjb2RlIjoiYmFjM2M0NTIiLCJhdWQiOjEsImlzcyI6ImFjcC1hcGktZGV2ZWxvcG1lbnQiLCJzdWIiOiJhY3AtbW9iaWxlLXVzZXIiLCJpYXQiOjE2NTAzMzMyMzcsImV4cCI6MTY1MDQxOTYzN30.c-fxvvGkF3Q_CuSl3ywUEQUd8HkZBCDjmbt03D_VbOk",
        "token_method": "HS256",
        "token_type": "Bearer",
        "expire_time": 1650419637,
        "nickname": "1号"
    }
}

将Token的中段Base64Decode后，可以序列化为一个Payload对象

Token Payload:

{
    "code": "d3c7e82e", //活动凭证
    "device": 1, //设备ID
    "aud": 13, //用户ID
    "iss":"acp-api-{环境变量}", //当前环境
    "sub":"acp-mobile-user", //颁发方
    "iat":1573116338, //颁发时间
    "exp":1573119938  //过期时间
}

HTTP Method

POST

HTTP Request

/api/mobile/access/token

Request Parameters Query

无

Request Parameters Body

Title Description Type Tips
code 活动凭证 String 活动唯一凭证（通过活动列表接口获取）
account 账号 String 默认admin
password 密码 String 默认acp_admin

Response Data

Title Type Description Tips
status int 状态 0 正常 1为失败
token string token字符串
token_method string 加密方式
token_type string token 的类型，目前应该固定为 Bearer
expire_time int 过期时间

Payload

Title Type Description Tips
code string 活动唯一凭证
aud string 使用管理员ID
iss string 颁发方
sub int 使用方 （设备ID）
iat int 颁发时间
exp int 过期时间

Log

日期 作者 内容
2022/04/13 易初 新增
2022/04/18 朱思嘉 修改

移动端退出登录（Mobile Clear Token）

MOBILE_CLEAR_TOKEN

{
    "status": 0
}

HTTP Method

GET

HTTP Request

/api/mobile/out

Request Parameters Query

无

Log

日期 作者 内容
2022/04/20 朱思嘉 新增

获取当前活动列表

MOBILE_ACTIVITY_LIST

Response Body :

{
    "status": 0,
    "data": [
        {
            "id": 23,
            "code": "bac3c452",
            "name": "MeetingSummit",
            "label": "2022集微峰会",
            "start_time": 1648778400,
            "end_time": 1652630399,
            "status": 1
        }
    ]
}

HTTP Method

GET

HTTP Request

/api/mobile/activity

Request Parameters Query

无

Response Data

Title Type Description Tips
id int 主键ID
code string 用户凭证
name string 活动名称
start_time int 开始时间
end_time int 结束时间
status int 状态 活动状态 0为结束 1为正常

Log

日期 作者 内容
2022/04/18 朱思嘉 新增

获取当前展厅列表

MOBILE_ACTIVITY_ROOM_LIST

Response Body :

{
    "status": 0,
    "data": [
        {
            "id": 6,
            "name": "默认展厅6",
            "label": "默认展厅",
            "type": 1,
            "status": 1,
            "activity_id": 1,
            "price": 0,
            "start_time": 1649658680,
            "end_time": 1649831480,
            "background_color": "",
            "color": "",
            "intro": null,
            "created_at": 1649665879,
            "updated_at": 1649665879,
            "deleted_at": null,
            "opening_time": "14:31-14:31",
            "hold_day": "04月11日",
            "is_active": true,
            "cover_type": "普通展厅"
        }]
}

HTTP Method

GET

HTTP Request

/api/mobile/activity/room

Request Parameters Query

无

Response Data

Title Type Description Tips
id int 主键ID
name string 展厅名称
label string 展厅标识
type int 展厅类型 1: 普通，2：收费，3：邀请
status int 展厅状态 1：开放 0：关闭
activity_id int 活动ID
price int 价格
start_time int 开始时间
end_time int 结束时间
background_color string 背景颜色
color string 字体颜色
intro string 展厅描述
created_at int 创建时间
updated_at int 修改时间
deleted_at int 删除时间
opening_time string 开放时间
hold_day string 举行时间
is_active bool 展厅状态 true：开放 false：关闭
cover_type string 展厅类型

Log

日期 作者 内容
2022/04/18 朱思嘉 新增

活动基础信息统计

GET_ACTIVITY_GUEST_REPORT

Response Body :

{
    "status": 0,
    "data": {
        "basic": [
            {
                "name": "签到人数（总）",
                "label": "",
                "total": 151,
                "extend": {}
            },
            {
                "name": "已签到人数（总）",
                "label": "",
                "total": 0,
                "extend": {}
            },
            {
                "name": "签到率（总）",
                "label": "",
                "total": "0%",
                "extend": {}
            },
            {
                "name": "普通访客（总）",
                "label": "",
                "total": 135,
                "extend": {}
            },
            {
                "name": "普通访客已签到",
                "label": "",
                "total": 0,
                "extend": {}
            },
            {
                "name": "普通访客签到率",
                "label": "",
                "total": "0%",
                "extend": {}
            },
            {
                "name": "VIP访客（总）",
                "label": "",
                "total": 16,
                "extend": {}
            },
            {
                "name": "VIP访客已签到",
                "label": "",
                "total": 0,
                "extend": {}
            },
            {
                "name": "VIP访客签到率",
                "label": "",
                "total": "0%",
                "extend": {}
            }
        ],
        "rooms": [
            {
                "name": "华亿展厅小小",
                "label": "第三届分析师大会",
                "total": 16,
                "extend": {
                    "signTotal": 6,
                    "radio": "38%"
                }
            },
            {
                "name": "电费展厅",
                "label": "第四届分析师大会",
                "total": 17,
                "extend": {
                    "signTotal": 4,
                    "radio": "24%"
                }
            },
            {
                "name": "阿斯顿展厅",
                "label": "第五届分析师大会",
                "total": 9,
                "extend": {
                    "signTotal": 3,
                    "radio": "33%"
                }
            },
            {
                "name": "大厦展厅",
                "label": "第六届分析师大会",
                "total": 4,
                "extend": {
                    "signTotal": 1,
                    "radio": "25%"
                }
            },
            {
                "name": "鸟语花香展厅",
                "label": "第七届分析师大会",
                "total": 5,
                "extend": {
                    "signTotal": 0,
                    "radio": "0%"
                }
            },
            {
                "name": "果树飘香展厅",
                "label": "第八届分析师大会",
                "total": 2,
                "extend": {
                    "signTotal": 0,
                    "radio": "0%"
                }
            }
        ]
    }
}

HTTP Method

GET

HTTP Request

/api/mobile/activity/report

Request Parameters Query

无

Response Data

Title Type Description Tips
name string 展厅名称
label string 展厅标签
total int 访客数量
extend object 扩展信息

extend Object

Title Type Description Tips
signTotal int 已签到人数
radio string 签到率

Log

日期 作者 内容
2022/04/22 朱思嘉 新增
2022/05/11 朱思嘉 修改

获取签到记录

GET_ACTIVITY_GUEST_RECORD

Response Body :

{
    "status": 0,
    "data": [
        {
            "id": 28,
            "check_time": 1651126766,
            "exhibition": "默认展厅6",
            "supervise": "18334786948",
            "type": "扫码"
        },
        {
            "id": 26,
            "check_time": 1651126766,
            "exhibition": "默认展厅6",
            "supervise": "18334786948",
            "type": "扫码"
        }
    ]
}

HTTP Method

GET

HTTP Request

/api/mobile/guest/record

Request Parameters Query

Title Description Type Required Tips
guest_id 访客ID int 是
limit 个数 int 否 defatule = 6
after_id 查看更多 int 否

Response Data

Title Type Description Tips
id int 主键ID
check_time int 签到时间
exhibition string 场地
supervise string 签到员
type string 签到方式

Log

日期 作者 内容
2022/04/24 朱思嘉 新增

手持设备数据同步接口

MOBILE_SYNC_GUEST_INFOs

强制进行全量模式同步

GET: /api/mobile/sync?force=1

--header 'Bearer: token'

时间戳模式

GET: /api/mobile/summit?start=1629111230

--header 'Bearer: token'

Request Body:

Push签到记录

[
    {
    "room_id": 1,
    "guest_id": 2,
    "access_time": "1650511582"
  },
  {
    "room_id": 2,
    "guest_id": 3,
    "access_time": "1650581513"
  }
]

Response Body :

Pull访客信息

{
    "status": 0,
    "data": [
        {
            "id": 1,
            "uuid": "c5fd753eebbf415f94f62a37445fdfd5",
            "order_num": "",
            "name": "测试1",
            "phone": 13333891144,
            "company": "",
            "position": "",
            "type": "普通嘉宾",
            "has_checkin": 1,
            "permissions": [
                6,
                7,
                9,
                10
            ],
            "access_count": 0,
            "tags": [
                {
                    "key": "是否参加校友会",
                    "value": "参加"
                }
            ],
            "updated_at": 1650511582
        },
        {
            "id": 2,
            "uuid": "857aa9f6d5364147b59ff99c74652d56",
            "order_num": "",
            "name": "测试1",
            "phone": 13333891144,
            "company": "",
            "position": "",
            "type": "普通嘉宾",
            "has_checkin": 1,
            "permissions": [
                6,
                7,
                9,
                10
            ],
            "access_count": 0,
            "tags": [],
            "updated_at": 1650511551
        },
        {
            "id": 3,
            "uuid": "f9318542453a43718f2eda22f2815969",
            "order_num": "",
            "name": "测试1",
            "phone": 13333891144,
            "company": "",
            "position": "",
            "type": "普通嘉宾",
            "has_checkin": 1,
            "permissions": [
                6,
                7,
                9,
                10
            ],
            "access_count": 0,
            "tags": [],
            "updated_at": 1650511508
        },
        {
            "id": 4,
            "uuid": "b4a48b7b7e874f05844dc058e62a319c",
            "order_num": "",
            "name": "测试123",
            "phone": 13333891144,
            "company": "",
            "position": "",
            "type": "普通嘉宾",
            "has_checkin": 1,
            "permissions": [
                6,
                7,
                9,
                10
            ],
            "access_count": 0,
            "tags": [],
            "updated_at": 1650511403,
            "created_at": 1650511403
        }
    ]
}

HTTP Method

GET

HTTP Request

/api/mobile/sync

Request Parameters Query

Title Description Type Required Tips
force 使用强制同步 int 否 任意值即可，优先级最高，同时传递其他参数，其他值会被覆盖
start 时间同步模式 int 否 10位时间戳

Request Parameters Body

Title Description Type Tips
room_id int 展厅房间ID
guest_id int 访客ID
access_time int 权限核销时间

Response Data

Title Description Type Tips
status 状态 int
data 返回数据 Object Array

data

Title Type Description Tips
id int 访客ID
uuid string 访客唯一标识
order_num string 访客订单号
name string 访客名字
phone string 访客手机
company string 访客公司
position string 访客职位
type string 访客类型
has_checkin int 是否到场签到（是否有热敏码）
permissions Array 访客的展厅权限ID列表
access_count int 访客权限消费次数
tags Object 访客的额外属性信息
updated_at int 访客信息更新时间 一定小于当前时间
created_at int 访客创建时间

tags

Title Type Description Tips
key string 属性名
value string 属性值

Log

日期 作者 内容
2022/04/13 易初 新增
2022/04/21 易初 修改
2022/04/22 易初 修改返回结构

访客展厅签到

ADD_CHECKIN_ROOM_LOG_TO_GUSET

签到并获取相关用户信息

POST: curl --location --request POST --X POST '/api/mobile/guest/c5fd753eebbf415f94f62a37445fdfd5/checkin_room_log' \

--header 'Content-Type: application/json' \

--header 'Bearer token'

Request Body :

{
    "room_id":6
}

Response Body :

{
  "status": 0,
  "data": {
    "code": 201,
    "id": 1172,
    "uuid": "c5fd753eebbf415f94f62a37445fdfd5",
    "order_num": "211308674754034803",
    "name": "测试1",
    "type": "普通嘉宾",
    "phone": "13333891144",
    "company": "爱集微",
    "position": "开发",
    "updated_at": 1650881426,
    "access_count": 15,
    "permissions": [
      {
        "id": 6,
        "name": "默认展厅6",
        "label": "默认展厅",
        "type": 1,
        "status": 1,
        "start_time": 1649658680,
        "end_time": 1649831480,
        "opening_time": "14:31-14:31",
        "hold_day": "04月11日",
        "is_active": true,
        "cover_type": "普通展厅"
      },
      {
        "id": 7,
        "name": "默认展厅7",
        "label": "默认展厅",
        "type": 1,
        "status": 1,
        "start_time": 1649745080,
        "end_time": 1649917880,
        "opening_time": "14:31-14:31",
        "hold_day": "04月12日",
        "is_active": true,
        "cover_type": "普通展厅"
      },
      {
        "id": 9,
        "name": "默认展厅",
        "label": "默认展厅",
        "type": 1,
        "status": 1,
        "start_time": 1649745080,
        "end_time": 1681194680,
        "opening_time": "14:31-14:31",
        "hold_day": "04月12日",
        "is_active": true,
        "cover_type": "普通展厅"
      }
    ]
  }
}

HTTP Method

POST

HTTP Request

/api/mobile/guest/{uuid}/checkin_room_log

Request Parameters Query

无

Response Data

Title Description Type Tips
data 签到记录 Array

data_item Object

Title Description Type Tips
code 接口标识 Int 201 为成功 202 失败嘉宾不存在 203 展厅不存在 204 尚未有权限
id 嘉宾id Int
uuid 嘉宾标识 String
order_num 名称 String
name 名称 String
type 名称 String
phone 名称 String
company 公司名称 String
position 职位 String
updated_at 更新时间 Int
access_count 签到记录 Int
permissions 权限 Array

permissions Object

Title Description Type Tips
id id Int
name 展厅名字 Int
label 展厅标识 Int
type 展厅类型 Int
status 展厅状态 Int
start_time 展厅开始时间 Int
end_time 展厅结束时间 Int
opening_time 展厅开放时间区间 String
hold_day 展厅开发日 String
is_active 展厅是否开放 Bool
cover_type 展厅所属类型 String
extra 展厅权限描述信息 String

Log

日期 作者 内容
2022/04/25 李世星 新增

签到自助机

扫码验证嘉宾详情

GET_SELF_HELP_GUEST_INFO

签到并获取相关用户信息

GET: curl --location --request GET --X GET '/api/self-help/guest/info?order_num=211308674754034803' \ --header 'Bearer token'

Response Body :

{
  "status": 0,
  "data": {
    "uuid": "c5fd753eebbf415f94f62a37445fdfd5",
    "order_num": "211308674754034803",
    "name": "测试1",
    "phone": 13333891144,
    "company": "",
    "type": {
      "id": 1,
      "name": "is_vip_fase",
      "label": "普通嘉宾",
      "color": "#FFFFFF"
    },
    "has_checkin": true,
    "rq_link": "http://xxxxxx.com/?uuid=c5fd753eebbf415f94f62a37445fdfd5"
  }
}

HTTP Method

GET

HTTP Request

/api/self-help/guest/info

Request Parameters Query

Title Description Type Required Tips
order_num 订单号 string 是

Request Parameters Body

无

Response Data

Title Description Type Tips
data 签到记录 Array

data Object

Title Description Type Tips
uuid 嘉宾标识码 string
order_num 嘉宾订单号 string
name 嘉宾名称 String
phone 嘉宾手机号 Int
company 嘉宾所属公司 String
type 嘉宾类型 Object
has_checkin 嘉宾是否签到 boole true 已签到 false 未签到
qr_link 二维码链接地址 String http://xxxxxx.com/?uuid=c5fd753eebbf415f94f62a37445fdfd5

type Object

Title Description Type Tips
id 类型 id Int
name 类型 名称 String
label 类型 标识 String
color 类型 颜色 String

Log

日期 作者 内容
2022/04/24 李世星 新增
2022/04/25 李世星 修改 增加 qr_link参数

自助机签到接口

ADD_SELF_HELP_CHECKIN_LOG_TO_GUSET

签到并获取相关用户信息

POST: curl --location --request POST --X POST '/api/self-help/guest/c5fd753eebbf415f94f62a37445fdfd5/checkin_log' \ --header 'Bearer token'

Response Body :

{
  "status": 0,
  "sign": {
    "id": 219,
    "place": "汽车峰会下午场",
    "model": "自助机",
    "time": 1650777729,
    "supervise": "默认管理员"
  }
}

HTTP Method

POST

HTTP Request

/api/self-help/guest/{uuid}/checkin_log

Request Parameters Query

无

Request Parameters Body

无

Response Data

Title Description Type Tips
sign 签到记录 Array

sign_Item Object

Title Description Type Tips
id 签到记录ID Int
place 签到地点 String
mode 签到方式 String
time 签到时间 Int
supervise 签到员 String

Log

日期 作者 内容
2022/04/24 李世星 新增

活动展厅

获取活动下的展厅列表

GET_ACTIVITY_ROOM_LIST

获取当前活动下所有的展厅列表

GET: /api/room

Response Body :

{
  "status": 0,
  "data": [
    {
      "id": 6,
      "name": "默认展厅6",
      "label": "默认展厅",
      "type": 1,
      "status": 1,
      "activity_id": 1,
      "price": 0,
      "start_time": 1649658680,
      "end_time": 1649831480,
      "background_color": "",
      "color": "",
      "intro": "",
      "created_at": 1649665879,
      "updated_at": 1649665879,
      "opening_time": "14:31-14:31",
      "hold_day": "04月11日",
      "is_active": true,
      "cover_type": "普通展厅"
    },
    {
      "id": 7,
      "name": "默认展厅7",
      "label": "默认展厅",
      "type": 1,
      "status": 1,
      "activity_id": 1,
      "price": 0,
      "start_time": 1649745080,
      "end_time": 1649917880,
      "background_color": "",
      "color": "",
      "intro": "",
      "created_at": 1649665998,
      "updated_at": 1649665998,
      "opening_time": "14:31-14:31",
      "hold_day": "04月12日",
      "is_active": true,
      "cover_type": "普通展厅"
    },
    {
      "id": 9,
      "name": "默认展厅",
      "label": "默认展厅",
      "type": 1,
      "status": 1,
      "activity_id": 1,
      "price": 0,
      "start_time": 1649745080,
      "end_time": 1681194680,
      "background_color": "",
      "color": "",
      "intro": "",
      "created_at": 1649727754,
      "updated_at": 1649727754,
      "opening_time": "14:31-14:31",
      "hold_day": "04月12日",
      "is_active": true,
      "cover_type": "普通展厅"
    },
    {
      "id": 10,
      "name": "默认展厅",
      "label": "默认展厅",
      "type": 2,
      "status": 1,
      "activity_id": 1,
      "price": 0,
      "start_time": 1649745080,
      "end_time": 1681194680,
      "background_color": "",
      "color": "",
      "intro": "",
      "created_at": 1649730833,
      "updated_at": 1649730833,
      "opening_time": "14:31-14:31",
      "hold_day": "04月12日",
      "is_active": true,
      "cover_type": "收费展厅"
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/room

Request Parameters Query

无

Request Parameters Body

无

Response Data

data

Title Description Type Tips
id Place ID Int
name 展厅名称 String
label 展厅标识 String
type 展厅数字类型 Int
status 展厅数字状态 Int
activity_id 展厅所属活动id Int
price 展厅价格 Int
start_time 展厅开始时间 Int
end_time 展厅结束时间 Int
background_color 展厅北京颜色 String
color 展厅字体颜色 String
intro 展厅描述 String
opening_time 展厅开发时间段 String
hold_day 展厅开放日 String
is_active 展厅是否开放 Bool true 开放 false 未开放
cover_type 展厅文字类型 String

Log

日期 作者 内容
2022/04/24 李世星 新增

标签

标签列表

GET_ACTIVITY_GUEST_TAGS_LIST

获取本活动所有支持的tagKey

GET: curl --location --request GET --X GET '/api/guest/tags?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/guest/tags

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/04/24 李世星 新增

新增标签

ADD_TAGS_ACTIVITY_TO_ACTIVITY

新增活动标签

POST: curl --location --request POST --X POST '/api/guest/tags' \ --header 'Bearer token'

Response Body :

{
  "status": 0,
  "data": {
    "id": 21,
    "name": "嘉宾类型",
    "created_at": "2022-04-15T07:30:41.000000Z",
    "updated_at": "2022-04-15T07:30:43.000000Z",
    "deleted_at": null
  }
}

HTTP Method

POST

HTTP Request

/api/guest/tags

Request Parameters Query

无

Request Parameters Body

Title Description Type Required Tips
tag_key key名称 String 是

Response Data

Title Description Type Tips
data 标签详情 Array

data Object

Title Description Type Tips
id 标签ID Int
name 标签名称 string

Log

日期 作者 内容
2022/04/24 李世星 新增

外部接口

查询指定单号的嘉宾日程安排数据

GET_ACTIVITY_GUEST_INFO

获取相关用户信息

GET: /api/external/guest/{order_num}/schedule --header 'Bearer token'

Response Body :

{
  "status": 0,
  "data": [
    {
      "hold_day": "04月28日",
      "info": [
        {
          "id": 7,
          "name": "电费展厅",
          "label": "第四届分析师大会",
          "start_time": 1651075200,
          "end_time": 1651100400,
          "opening_time": "00:00-07:00",
          "hold_day": "04月28日",
          "cover_type": "收费展厅",
          "extra": "",
          "allow_entry": true
        },
        {
          "id": 10,
          "name": "大厦展厅",
          "label": "第六届分析师大会",
          "start_time": 1651075200,
          "end_time": 1651111200,
          "opening_time": "00:00-10:00",
          "hold_day": "04月28日",
          "cover_type": "收费展厅",
          "extra": "",
          "allow_entry": true
        },
        {
          "id": 6,
          "name": "华亿展厅小小",
          "label": "第三届分析师大会",
          "start_time": 1651075200,
          "end_time": 1651158000,
          "opening_time": "00:00-23:00",
          "hold_day": "04月28日",
          "cover_type": "收费展厅",
          "extra": "",
          "allow_entry": true
        }
      ]
    }
  ]
}

HTTP Method

GET

HTTP Request

/api/external/guest/{order_num}/schedule

Request Parameters Query

Title Description Type Required Tips
order_num 嘉宾订单 numeric 是 16-18位订单号

Request Parameters Body

无

Response Data

Title Description Type Tips
status code 0为成功 Number
data 日程安排详情 Array

data

Title Description Type Tips
hold_day 日程日期 String
info 单日安排详情 Array

info Object

Title Description Type Tips
id 展厅会议id Int
name 展厅会议名称 String
label 展厅会议别称 String
start_time 展厅会议举办开始日期 Int
end_time 展厅会议举办结束日期 Int
opening_time 展厅会议举办间隔日期 String
hold_day 展厅会议所属日 String
cover_type 展厅会议类型 String
extra 事宜 String
allow_entry 是否拥有权限 Bool true 拥有 false 未拥有

自定义对象

Log

日期 作者 内容
2022/05/13 李世星 新增

为嘉宾添加指定房间权益

EXTERNAL_SET_ONE_SCHEDULE

为指定单号添加房间权益

PUT: /api/external/guest/schedule/addOne' \

--header 'Authorization: Bearer 6aeeaaef4dc61fe0af93ca497b9e2a172f5614222fa3f7de5b5a19fe88529985' \ --header 'Content-Type: application/json' \ --data '{ \ "room_label": "第七届分析师大会", \ "order_num":4294967296 \ }'

Request Body :

{
    "room_label": "第七届分析师大会",
    "order_num":4294967296
}

Response Body :

{
  "status": 0,
  "data": {
    "room_id": 99,
    "room_label": "第七届分析师大会"
  }
}

HTTP Method

PUT

HTTP Request

/api/external/guest/schedule/addOne

Request Parameters Query

无

Request Parameters Body

Title Description Type Required Tips
order_num 嘉宾订单 numeric 是 16-18位订单号
room_label 房间名称 String 是 房间名称
extra 嘉宾事宜 String 否 嘉宾事宜（座位、附加信息、出席职位

Response Data

Title Description Type Tips
status code 0为成功 Number
data 添加成功后返回房间信息 Array

data

Title Description Type Tips
room_id 房间id Int
room_label 房间名称 String

自定义对象

Log

日期 作者 内容
2022/05/17 李世星 新增

文档使用帮助

在index.html.md文件中进行编辑目录和文档总体结构，然后在includes目录中添加对应的模块。

文档使用Markdown语言排版。

Markdown格式示例


# 标题
## 二级标题
### .......

​``` json
代码块
​```

表格
表头 | 表头 
---------- | -------
内容 | 内容 
内容 | 内容 

`Something`

表格

表头 表头
内容 内容
内容 内容

Json 是没有注释的 避免在json中写注释

Something 高亮

加粗 粗体

横线

下划线

斜体

链接

图片

json