滄州市實名制用工

二○二一年十一月

目錄TOC\o"1-3"\h\u1api接口說明 41.1操作步驟說明 41.2整體流程圖 42接口調(diào)用 62.1設備心跳 62.1.1請求地址 62.1.2請求參數(shù)說明 62.1.3響應參數(shù)說明 72.2設備獲取任務 72.2.1請求地址 72.2.2請求參數(shù)說明 82.2.3響應參數(shù)說明 82.2.4公共響應參數(shù) 82.2.5添加人員任務data數(shù)據(jù)返回格式 92.2.6添加人臉任務data數(shù)據(jù)返回格式 92.2.7修改人臉任務data數(shù)據(jù)返回格式 92.2.8刪除人員任務data數(shù)據(jù)返回格式 102.3設備任務執(zhí)行異步結(jié)果通知 112.3.1請求地址 112.3.2請求參數(shù)說明 112.3.3響應參數(shù)說明 122.4考勤信息上傳 122.4.1請求地址 122.4.2請求參數(shù)說明 132.4.3響應參數(shù)說明 143附錄 143.1code碼對照表 143.2聯(lián)系人 151api接口說明服務端接口采用標準http協(xié)議通訊，數(shù)據(jù)以json格式放在body中傳輸。設備廠商在開發(fā)時，需要向服務端申請，由服務端發(fā)放賬號username跟密碼password，設備廠商需要按照文檔中接口對接。設備廠商的設備在上線到工地后，設備ip地址是與工地互相綁定的，請設備廠商在開發(fā)時采用設備和服務端直連的方式，不要進行服務器中轉(zhuǎn)和服務端對接，以免ip綁定限制。1.1操作步驟說明步驟一設備通過設備心跳接口每隔30秒詢問服務端。服務端向設備返回trueorfalse的值。true:代表服務端有任務需要設備執(zhí)行，業(yè)務流轉(zhuǎn)到設備獲取任務的URL接口；false：判斷為無任務，即無需處理。步驟二在設備心跳接口接收到true值后，調(diào)用設備獲取任務的URL接口，傳入需要調(diào)用接口的參數(shù)，進行接口調(diào)用，服務端如果有任務會返回true值和任務，服務端每次只返回一條任務，而且返回的任務是有序的，需要設備按照先進先出的原則，把任務放在隊列中順序執(zhí)行。步驟三設備每處理完一條任務后，不管執(zhí)行結(jié)果是成功或失敗，都需要調(diào)用設備任務執(zhí)行異步結(jié)果通知接口返回處理結(jié)果。所有接口都是content-typeapplication/json類型1.2整體流程圖特別說明：設備端需要單線程按順序?qū)θ蝿者M行處理，防止任務執(zhí)行順序顛倒，導致任務失敗。2接口調(diào)用2.1設備心跳2.1.1請求地址請求方式請求地址post22:8083/JoinEquipment/deviceHeartBeat測試環(huán)境http://36x7387y75.qicp.vip/JoinEquipment/deviceHeartBeat2.1.2請求參數(shù)說明參數(shù)名稱類型是否必填最大長度描述備注usernameString是32服務端分配的開發(fā)者賬號公共請求參數(shù)passwordString是64服務端分配的開發(fā)者密碼公共請求參數(shù)deviceTimeString是64設備當前時間deviceKeyString是64設備唯一標識碼2.1.3響應參數(shù)說明參數(shù)名稱類型是否必填最大長度描述備注statusString是-成功標志FAILURE/SUCCESScodeString是-接口返回碼，詳見接口code碼對照表msgString是-消息taskFlagboolean是-服務端任務標識，如果為true說明有任務，需要設備調(diào)用任務獲取接口獲取任務2.2設備獲取任務2.2.1請求地址請求方式請求地址post22:8083/JoinEquipment/getTask測試環(huán)境http://36x7387y75.qicp.vip/JoinEquipment/getTask2.2.2請求參數(shù)說明參數(shù)名稱類型是否必填最大長度描述備注usernameString是32服務端分配的開發(fā)者賬號公共請求參數(shù)passwordString是64服務端分配的開發(fā)者密碼公共請求參數(shù)deviceKeyString是64設備唯一標識碼2.2.3響應參數(shù)說明2.2.4公共響應參數(shù)參數(shù)名稱類型是否必填最大長度描述備注statusString是-成功標志FAILURE/SUCCESScodeString是-接口返回碼，詳見接口code碼對照表msgString是-消息taskFlagboolean是-服務端任務標識，如果為true說明獲取到了可以執(zhí)行的任務dataJson否-當taskFlag為false時data為null2.2.5添加人員任務data數(shù)據(jù)返回格式參數(shù)名稱類型是否必填最大長度描述備注taskKeyString是-任務唯一編號interfaceNameString是-接口名稱person/createpersonIdString是-人員idpersonNameString是-人員姓名2.2.6添加人臉任務data數(shù)據(jù)返回格式參數(shù)名稱類型是否必填最大長度描述備注taskKeyString是-任務唯一編號interfaceNameString是-接口名稱face/createByBase64personIdString是-人員id和添加人員的id對應personImageBase64String(base64)是-人臉照片，格式jpg2.2.7修改人臉任務data數(shù)據(jù)返回格式參數(shù)名稱類型是否必填最大長度描述備注taskKeyString是-任務唯一編號interfaceNameString是-接口名稱face/updatepersonIdString是人員id和添加人員的id對應personImageBase64String(base64)是人臉照片，格式jpg2.2.8刪除人員任務data數(shù)據(jù)返回格式特別說明：設備需要同時刪除人員和人臉信息參數(shù)名稱類型是否必填最大長度描述備注taskKeyString是-任務唯一編號interfaceNameString是-接口名稱person/deletepersonIdString是人員id對應2.3設備任務執(zhí)行異步結(jié)果通知2.3.1請求地址請求方式請求地址post22:8083/JoinEquipment/taskCallback測試環(huán)境http://36x7387y75.qicp.vip/JoinEquipment/taskCallback2.3.2請求參數(shù)說明參數(shù)名稱類型是否必填最大長度描述備注usernameString是32服務端分配的開發(fā)者賬號公共請求參數(shù)passwordString是64服務端分配的開發(fā)者密碼公共請求參數(shù)deviceKeyString是64設備唯一標識碼datajson是-taskKeyString是64任務唯一編號data中的子項successboolean是-任務成功失敗標識data中的子項msgString是200設備端自定義，描述具體成功或失敗原因data中的子項numString是20設備端自定義，成功或失敗原因編碼data中的子項2.3.3響應參數(shù)說明特別說明：如果該次請求沒有響應，請建立任務嘗試間隔并多次通知，直到通知成功為止。參數(shù)名稱類型是否必填最大長度描述備注statusString是-成功標志FAILURE/SUCCESScodeString是-接口返回碼，詳見接口code碼對照表msgString是-消息2.4考勤信息上傳2.4.1請求地址請求方式請求地址post22:8083/JoinEquipment/identifyCallBack測試環(huán)境http://36x7387y75.qicp.vip/JoinEquipment/identifyCallBack2.4.2請求參數(shù)說明參數(shù)名稱類型是否必填最大長度描述備注UsernameString是32服務端分配的開發(fā)者賬號公共請求參數(shù)pqsswordString是64服務端分配的開發(fā)者密碼公共請求參數(shù)deviceKeyString是64設備唯一標識碼datajson是-personIdString是64人員iddata中的子項personIdentifyTimeString是-人員考勤時間yyyy-MM-ddhh:mm:ssdata中的子項personPhotoBase64String是-設備考勤圖片，格式jpgdata中的子項personTemperatureString否(不支持測溫可以不用填)-人員考勤時體溫data中的子項2.4.3響應參數(shù)說明特別說明：如果沒有響應，請建立任務嘗試間隔并多次通知，通知成功為止，否者會沒有該次考勤，服務端返回SUCCESS即為通知成功參數(shù)名稱類型是否必填最大長度描述備注statusString是-成功標志FAILURE/SUCCESScodeSt