Files
shz-backend/docs/app-outdoor-fair-h5-api.md

66 lines
1.9 KiB
Markdown
Raw Normal View History

# 户外招聘会企业 H5 公共接口
基础路径:`/app/outdoor-fair`
## 1. 扫码进入企业 H5
**请求方式:** `GET`
**请求路径:** `/company-page`
**请求参数:**
| 参数 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| deviceCode | String | 是 | 后台设备码绑定企业后生成的扫码参数 |
**响应字段:**
| 字段 | 说明 |
| --- | --- |
| fair | 户外招聘会信息 |
| company | 企业信息 |
| booth | 企业展位信息,未分配展位时为空 |
| jobs | 当前企业在本场招聘会下的岗位列表 |
| fairH5Url | 本场招聘会 H5 链接 |
| companyH5Url | 当前企业 H5 链接 |
| qrCodeContent | 二维码内容,前端用该值生成二维码 |
| deviceId | 绑定设备码 ID |
| deviceCode | 绑定设备码 |
## 2. 通过招聘会和企业获取 H5 数据
**请求方式:** `GET`
**请求路径:** `/{fairId}/companies/{companyId}/page`
用于未绑定设备码或后台预览企业 H5 页面。
## 3. 获取招聘会公共详情
**请求方式:** `GET`
**请求路径:** `/{fairId}`
返回 `fair``fairH5Url`
## 4. 后台参会企业二维码入口
后台接口 `GET /cms/outdoor-fair/{fairId}/companies` 的每行企业现在额外返回:
| 字段 | 说明 |
| --- | --- |
| deviceId | 已绑定设备码 ID未绑定为空 |
| deviceCode | 已绑定设备码,未绑定为空 |
| h5Url | 企业 H5 链接,格式为 `/h5/outdoor-fair/company.html?fairId={fairId}&companyId={companyId}` |
| qrCodeContent | 二维码内容,前端点击“查看二维码”时用该值生成二维码 |
也可以调用 `GET /cms/outdoor-fair/{fairId}/companies/{companyId}/qrcode` 单独获取某个参会企业的二维码内容。
## 5. 已提供的静态 H5
| 页面 | 说明 |
| --- | --- |
| `/h5/outdoor-fair/company.html?fairId={fairId}&companyId={companyId}` | 扫码后的参会企业公共页 |
| `/h5/outdoor-fair/detail.html?fairId={fairId}` | 招聘会公共详情页 |