[Toc]
幫幫找接口文檔 v1.0
附錄
1.錯(cuò)誤描述errorCode
| 錯(cuò)誤碼 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| 1200 | int | 操作成功 |
| 1500 | int | 操作失敗 |
2.圖片上傳
簡(jiǎn)要概述
所有圖片均以此接口進(jìn)行上傳,以流進(jìn)行傳輸.
上傳后將圖片地址返回.參數(shù)
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| image | 是 | string | 圖片名 |
- 返回
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| url | 是 | string | 圖片地址 |
3.其他
- 所有列表項(xiàng)均有pageNo字段(頁(yè)數(shù)).請(qǐng)自行添加,以下接口不再對(duì)此字段做描述.
一.登錄注冊(cè)
1.0 注冊(cè)接口
請(qǐng)求URL:
/interface/user/register
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| phone | 是 | string | 手機(jī)號(hào)碼 |
| password | type=2 | string | 登錄密碼 |
| openId | type!=2 | string | 微信/qq唯一標(biāo)識(shí)號(hào) |
| headImage | type!=2 | string | QQ微信頭像地址 |
| nickname | type!=2 | string | QQ微信昵稱(chēng) |
| type | 是 | sting | 0:微信登錄 1 QQ登錄 2 手機(jī)號(hào)登錄 |
返回示例
{
"errorCode" : "1200",
"msg" : "操作成功",
"data" : {
"headImage":"",
"idcard":"",
"name":"",
"phone":"12345678000",
"userId":"18",
"userType":""
}
}
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| userId | string | 用戶(hù)id |
| userType | string | 用戶(hù)類(lèi)型,雇主,施工單位,工人 |
| headImage | string | 頭像地址 |
| name | string | 用戶(hù)名 |
| phone | string | 手機(jī)號(hào) |
| idcard | string | 身份證號(hào)碼 |
1.1 登錄接口

簡(jiǎn)要描述:
- 用戶(hù)可通過(guò)微信登錄/QQ登錄/手機(jī)號(hào)登錄
若用戶(hù)通過(guò)微信/QQ登錄,系統(tǒng)可自動(dòng)注冊(cè).
若用戶(hù)通過(guò)手機(jī)號(hào)登錄,需要驗(yàn)證是否存在,存在則登錄,否則注冊(cè)。
請(qǐng)求URL:
/interface/user/login
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| phone | type=2 | string | 手機(jī)號(hào)碼 |
| password | type=2 | string | 登錄密碼 |
| openId | type!=2 | string | 微信/qq唯一標(biāo)識(shí)號(hào) |
| headImage | type!=2 | string | QQ微信頭像地址 |
| nickname | type!=2 | string | QQ微信昵稱(chēng) |
| type | 是 | sting | 0:微信登錄 1 QQ登錄 2 手機(jī)號(hào)登錄 |
返回示例
{
"errorCode" : "1200",
"msg" : "操作成功",
"data" : {
"headImage":"",
"idcard":"",
"name":"",
"phone":"12345678000",
"userId":"18",
"userType":""
}
}
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| userId | string | 用戶(hù)id |
| userType | string | 用戶(hù)類(lèi)型,雇主,施工單位,工人 |
| headImage | string | 頭像地址 |
| name | string | 用戶(hù)名 |
| phone | string | 手機(jī)號(hào) |
| idcard | string | 身份證號(hào)碼 |
1.2 找回密碼/修改密碼
注:前端使用驗(yàn)證碼校驗(yàn)
簡(jiǎn)要描述:
- 用戶(hù)登錄接口
請(qǐng)求URL:
/interface/user/getPass
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| phoneNumber | 是 | string | 用戶(hù)名 |
| password | 是 | string | 新密碼 |
返回示例
{
"errorCode":"1200",
"msg":"操作成功",
"data":{
"headImage":"",
"idcard":"",
"name":"",
"phone":"12345678000",
"userId":"18",
"userType":""
}
}
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| userId | string | 用戶(hù)id |
| userType | string | 用戶(hù)類(lèi)型,雇主,施工單位,工人 |
| headImage | string | 頭像地址 |
| name | string | 用戶(hù)名 |
| phone | string | 手機(jī)號(hào) |
1.3 完善個(gè)人信息(實(shí)名認(rèn)證)
簡(jiǎn)要描述:
- 用戶(hù)實(shí)名認(rèn)證,所有用戶(hù)必須通過(guò)實(shí)名認(rèn)證后才可使用app功能.
請(qǐng)求URL:
/interface/user/aotonmy
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)ID |
| headImage | 是 | string | 頭像 |
| name | 是 | string | 姓名 |
| sex | 是 | string | 性別 |
| birthday | 是 | date | 生日 |
| idcard | 是 | string | 身份證號(hào) |
| address | 是 | string | 地址 |
返回示例
{
"errorCode":"1200",
"msg":"操作成功"
}
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| code | string | 1:成功 0 :失敗 |
1.4 審核成為工人
簡(jiǎn)要描述:
- 用戶(hù)實(shí)名認(rèn)證后,可審核成為工人.
請(qǐng)求URL:
/interface/user/checkWorker
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)ID |
| idCardF | 是 | string | 身份證正面 |
| idCardB | 是 | string | 身份證反面 |
| idCardH | 是 | string | 手持身份證 |
| workType | 是 | String | 工種 |
| experience | 是 | string | 經(jīng)驗(yàn) |
| speciality | 是 | string | 特長(zhǎng) |
| certificate | 是 | string | 證書(shū) |
| descript | 是 | string | 自我描述 |
返回示例
無(wú)
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| code | string | 1:成功 0 :失敗 |
| status | string | 0 :未審核 1: 通過(guò) 2:未通過(guò) |
| createUser | string | 審核人 |
| checkTime | string | 審核時(shí)間 |
| cause | string | 未通過(guò)原因(根據(jù)具體情況顯示) |
1.5 審核成為施工單位/材料廠(chǎng)商
簡(jiǎn)要描述:
- 用戶(hù)實(shí)名認(rèn)證后,可審核成為施工單位/材料廠(chǎng)商.
請(qǐng)求URL:
/interface/user/checkUnit
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)ID |
| comLogo | 是 | string | 公司logo |
| comName | 是 | string | 公司名稱(chēng) |
| workAddr | 是 | string | 辦公地址 |
| telephone | 是 | String | 座機(jī) |
| certificate | 是 | string | 營(yíng)業(yè)執(zhí)照 |
| picture | 是 | string | 圖片 |
| information | 是 | string | 其他信息 |
返回示例
無(wú)
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| code | string | 1:成功 0 :失敗 |
| status | string | 0 :未審核 1: 通過(guò) 2:未通過(guò) |
| createUser | string | 審核人 |
| checkTime | string | 審核時(shí)間 |
| cause | string | 未通過(guò)原因(根據(jù)具體情況顯示) |
注:工人列表/詳情,職位列表/詳情,請(qǐng)求URL:
/interface/demand/demandList
二.找工人
2.1 工人列表

簡(jiǎn)要描述:
- 附近的工人列表
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| longitude | 是 | string | 經(jīng)度 |
| latitude | 是 | string | 緯度 |
返回示例
無(wú)
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| id | string | 工人id |
| name | string | 工人姓名 |
| workType | string | 工人 |
| speciality | string | 擅長(zhǎng) |
| rank | string | 星級(jí) |
| longitude | string | 經(jīng)度 |
| latitude | string | 緯度 |
2.2 工人詳情

簡(jiǎn)要描述:
- 工人詳情
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| workerId | 是 | string | 工人id |
| longitude | 是 | string | 經(jīng)度 |
| latitude | 是 | string | 緯度 |
返回示例
無(wú)
返回參數(shù)說(shuō)明
- 自行參考設(shè)計(jì)稿中所有字段
- isCollection 是否收藏(/interface/user/isCollection)
- 工人評(píng)價(jià)信息(/interface/demand/wokerCommentList)
2.2.1 收藏/取消收藏工人
簡(jiǎn)要描述:
- 附近的工人列表
請(qǐng)求URL:
/interface/user/addCollection/interface/user/deleteCollection
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| workerId | 是 | string | 工人id |
| type | 是 | string | 1:收藏 0 取消收藏 |
返回示例
無(wú)
返回參數(shù)說(shuō)明
- 返回成功/失敗即可
2.2.2 雇傭該工人(沒(méi)寫(xiě)呢)
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| workerId | 是 | string | 工人id |
| detail | 是 | string | 備注信息 |
返回:
- 返回成功或者失敗即可.
2.3 發(fā)布求職
簡(jiǎn)要描述:
- 發(fā)布求職
請(qǐng)求URL:
/interface/work/applyJob
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| workerId | 是 | string | 工人id |
| exAddr | 是 | string | 期望工作地點(diǎn) |
| exSalary | 是 | string | 期望薪水 |
| remark | 是 | string | 備注 |
| entryTime | 是 | string | 入職時(shí)間 |
返回示例
無(wú)
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| name | string | 工人姓名 |
| age | string | 出生年月(處理成年齡) |
| sex | string | 性別 |
| rank | string | 星級(jí) |
| address | string | 住址 |
| workType | int | 工種 |
| speciality | string | 擅長(zhǎng) |
| descript | string | 自我描述 |
| exAddr | string | 期望工作地點(diǎn) |
| exSalary | string | 期望薪資 |
| remark | string | 備注 |
| entryTime | string | 入職時(shí)間 |
三.找工作
3.1職位列表

簡(jiǎn)要描述:
- 職位列表
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| longitude | 是 | string | 經(jīng)度 |
| latitude | 是 | string | 緯度 |
返回示例
無(wú)
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| id | string | 工作id |
| name | string | 發(fā)布者 |
| time | long | 發(fā)布時(shí)間(時(shí)間戳) |
| projectName | String | 項(xiàng)目名 |
| period | string | XX年XX月XX日到XX年XX月XX日 |
| workAddr | string | 工作地點(diǎn) |
| remark | string | 備注 |
| needList | list | 所需工種 |
其中needList內(nèi)字段主要為:(單獨(dú)接口)
請(qǐng)求URL:
/interface/demand/needList
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| workType | int | 工種id |
| personNum | int | 當(dāng)前工種人數(shù) |
| salaryType | int | 薪資類(lèi)型 |
| salary | double | 薪資 |
3.1.1 申請(qǐng)加入(沒(méi)寫(xiě)呢)
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| workId | 是 | string | 職位id |
| detail | 是 | string | 備注信息 |
返回:
- 返回成功或者失敗即可.
3.2 發(fā)布職位
請(qǐng)求URL:
/interface/work/recruit
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| projectName | 是 | string | 項(xiàng)目名稱(chēng) |
| period | 是 | string | 項(xiàng)目周期(起止時(shí)間 xxxx年xx月xx日至xxxx年xx月xx日) |
| workAddr | 是 | string | 工作地點(diǎn) |
| remark | 是 | string | 備注信息 |
| needList | 是 | string | 需求列表 |
其中needList內(nèi)字段主要為:
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| workType | int | 工種id |
| personNum | int | 需求人數(shù) |
| salaryType | int | 薪資類(lèi)型 1 日薪 2 月薪 3 年薪 |
| salary | double | 薪資 |
返回:
- 返回成功或者失敗即可.
四.找材料(沒(méi)寫(xiě))
4.1 采購(gòu)清單列表

簡(jiǎn)要描述:
- 采購(gòu)清單列表
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| type | 是 | string | 1:已提交的清單 0:未提交清單 |
返回示例
無(wú)
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| inventoryId | string | 清單id |
| inventoryName | string | 清單名稱(chēng) |
| inventoryDetail | List | 清單內(nèi)所含商品 |
其中inventoryDetail內(nèi)含字段為:
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| goodId | string | 商品名 |
| goodNum | string | 數(shù)量 |
| goodImage | string | 商品圖片 |
| goodState | string | 商品狀態(tài):(1已收到x家商家報(bào)價(jià),2已選擇某某商家) |
| marchantPrice | string | 已選中的商家報(bào)價(jià)金額 |
4.2 清單詳細(xì)信息

簡(jiǎn)要描述:
- 清單詳細(xì)信息
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| purchasingId | 是 | string | 清單Id |
返回示例
無(wú)
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| inventoryId | string | 清單id |
| inventoryName | string | 清單名稱(chēng) |
| inventoryDetail | List | 清單內(nèi)所含商品 |
其中inventoryDetail內(nèi)含字段為:
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| goodId | string | 商品名 |
| merchantName | string | 商家名稱(chēng) |
| goodNum | string | 數(shù)量 |
| goodImage | string | 商品圖片 |
| goodState | string | 商品狀態(tài):(1已收到x家商家報(bào)價(jià),2已選擇某某商家) |
| marchantPrice | string | 已選中的商家報(bào)價(jià)金額 |
4.3 生成訂單
4.4 發(fā)布清單
五.交流大廳
5.1 大廳列表

簡(jiǎn)要描述:
- 交流大廳,排序優(yōu)先將附近的排在最前面,不含評(píng)論
請(qǐng)求URL:
/interface/exchange/exchangeList
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| longitude | 是 | string | 經(jīng)度 |
| latitude | 是 | string | 緯度 |
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| id | string | 用戶(hù)id |
| icon | string | 用戶(hù)頭像 |
| name | string | 用戶(hù)姓名 |
| time | string | 發(fā)布時(shí)間 時(shí)間戳 |
| longitude | string | 經(jīng)度 |
| latitude | string | 緯度 |
| content | string | 用戶(hù)發(fā)的內(nèi)容 |
| image | string | 圖片地址,多張圖片以逗號(hào)隔開(kāi) |
5.1.1 交流詳情
簡(jiǎn)要描述:
- 動(dòng)態(tài)的具體信息,含該動(dòng)態(tài)所有評(píng)論信息
請(qǐng)求URL:
/interface/exchange/exchangeDetail
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| communityId | 是 | string | 條目id |
返回參數(shù)說(shuō)明
- 主要返回的是評(píng)論數(shù)據(jù)
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| id | string | 評(píng)論條目id |
| userId | string | 評(píng)論者id |
| name | string | 用戶(hù)姓名 |
| time | string | 發(fā)布時(shí)間 時(shí)間戳 |
| word | string | 評(píng)論內(nèi)容 |
5.1.2 發(fā)表評(píng)論
請(qǐng)求URL:
/interface/exchange/addComment
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| communityId | 是 | string | 狀態(tài)id |
| content | 是 | string | 內(nèi)容 |
| picture | 是 | string | 圖片 |
返回參數(shù)說(shuō)明
- 返回成功/失敗
5.2 發(fā)布狀態(tài)
請(qǐng)求URL:
/interface/exchange/addCommunity
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)id |
| longitude | 是 | string | 經(jīng)度 |
| latitude | 是 | string | 緯度 |
| content | 是 | string | 內(nèi)容 |
| image | 是 | string | 圖片地址,多張圖片以逗號(hào)隔開(kāi) |
返回參數(shù)說(shuō)明
- 返回成功/失敗
六.個(gè)人中心
6.1 個(gè)人信息
簡(jiǎn)要描述:
- 用戶(hù)登錄接口
請(qǐng)求URL:
/interface/user/userInfo
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)ID |
返回示例
{
"errorCode":"1200",
"msg":"操作成功",
"data":{
"headImage":"",
"idcard":"",
"name":"",
"phone":"12345678000",
"nickname":"",
"sex":"",
"birthday":"",
"userId":"18",
"userType":""
}
}
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| userId | string | 用戶(hù)id |
| userType | string | 用戶(hù)類(lèi)型,雇主,施工單位,工人 |
| headImage | string | 頭像地址 |
| name | string | 用戶(hù)名 |
| phone | string | 手機(jī)號(hào) |
| nickname | string | 用戶(hù)昵稱(chēng) |
| sex | string | 性別 |
| birthday | string | 出生年月 |
| idcard | string | 身份證號(hào) |
| address | string | 地址 |
6.2 我的錢(qián)包
6.3 我的收藏
簡(jiǎn)要描述:
- 用戶(hù)登錄接口
請(qǐng)求URL:
/interface/user/userCollectionList
請(qǐng)求方式:
- POST /GET
參數(shù):
| 參數(shù)名 | 必選 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|---|
| userId | 是 | string | 用戶(hù)ID |
返回示例
{
"errorCode":"1200",
"msg":"操作成功",
"data":{
"collectionId":"",
"title":"",
"createTime":"",
"tableId":"18",
"tableName":""
}
}
返回參數(shù)說(shuō)明
| 參數(shù)名 | 類(lèi)型 | 說(shuō)明 |
|---|---|---|
| collectionId | string | 收藏id |
| title | string | 簡(jiǎn)要描述 |
| createTime | string | 收藏時(shí)間 |
| tableId | string | 被收藏人id |
| tableName | string | 被收藏人姓名 |