內(nèi)蒙古建筑業(yè)從業(yè)人員實名制管理服務信息平臺(V2.0)考勤設(shè)備通用集成接口方案_第1頁
內(nèi)蒙古建筑業(yè)從業(yè)人員實名制管理服務信息平臺(V2.0)考勤設(shè)備通用集成接口方案_第2頁
內(nèi)蒙古建筑業(yè)從業(yè)人員實名制管理服務信息平臺(V2.0)考勤設(shè)備通用集成接口方案_第3頁
內(nèi)蒙古建筑業(yè)從業(yè)人員實名制管理服務信息平臺(V2.0)考勤設(shè)備通用集成接口方案_第4頁
內(nèi)蒙古建筑業(yè)從業(yè)人員實名制管理服務信息平臺(V2.0)考勤設(shè)備通用集成接口方案_第5頁
已閱讀5頁,還剩11頁未讀, 繼續(xù)免費閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認領(lǐng)

文檔簡介

附件1內(nèi)蒙古自治區(qū)建筑業(yè)從業(yè)人員實名制管理服務信息平臺(V2.0)考勤設(shè)備通用集成接口方案集成總體業(yè)務流程向?qū)嵜破脚_(V2.0)https整。API調(diào)用說明Https接口規(guī)范拼裝一個正確的URL,通過HTTPS請求到實名制平臺(V2.0)接口。調(diào)用原理示意圖如下。URL地址https://域名:端口/function?輸入?yún)?shù)1=xx&輸入?yún)?shù)2=xxEncodingUTF-8MethodPOSTBodyJSON數(shù)據(jù)返回JSON數(shù)據(jù)調(diào)用API,必須傳入輸入?yún)?shù)和應用參數(shù)(POST的BODY數(shù)據(jù))。參數(shù)類型參數(shù)使用說明輸入?yún)?shù)輸入?yún)?shù)放在url參數(shù)區(qū),即?后的參數(shù),例如https://域名:端口/function?token=xx中的token應用參數(shù)應用參數(shù)放在POST的body數(shù)據(jù)區(qū)(signature)signature(POSTBODY及平apisecretMD5bodybody{},body{body示例簽名步驟:示例簽名步驟:所有參數(shù)為:token=testtimestamp=2018-06-1009:05:03應用參數(shù):body體里無參數(shù)時為{}(body體里有參數(shù)時示例{”license”:”xxxxxxxxxxxx”})連接組合字符串連接參數(shù)名與參數(shù)值,并在首尾加上隱含驗簽因子連接參數(shù)名與參數(shù)值,并在首尾加上隱含驗簽因子apisecret的值,示例值為secret123,組合字符串如下(采用body體里無參方式):secret123tokentesttimestamp2018-06-1009:05:03body{}secret123UTF-8apisecret3)生成簽名(signature):用通用MD5算法對組合字符串進行加密,產(chǎn)生32位大寫MD5值注意事項所有的請求和響應數(shù)據(jù)編碼皆為utf-8格式,url里的所有參數(shù)值請做urlencode編碼。(說明:三位錯誤碼代表即時反饋,四位錯誤碼為異步查詢結(jié)果)code結(jié)果200成功500系統(tǒng)異常511參數(shù)中存在必填字段為空101簽名錯誤102非法時間戳,允許客戶端請求時間誤差6分鐘103請求體解析錯誤104異步查詢錯誤105通行時間沒到,或者過期106通行方式值有誤107體溫不在正常范圍內(nèi)35-42108超過一次最多拆查詢?nèi)藬?shù)(1000)109通行方向值有誤110token不存在或已失效111同一設(shè)備在多地請求112license或mac驗證失敗114經(jīng)度參數(shù)不合法115緯度參數(shù)不合法1001未查到此設(shè)備數(shù)據(jù)1002設(shè)備未處于運行狀態(tài)1003設(shè)備綁定的工程已竣工1004人員信息不存在1005人員不曾屬于該項目或單位或人員狀態(tài)為結(jié)束1006考勤記錄重復1007圖片Base64解碼失敗1008不允許同一人頻繁往同一方向上報考勤(一分鐘內(nèi))API接口說明接口服務APIAPI接口名稱API描述/get-token獲取訪問令牌/get-time心跳維持/get-employees-hash獲取人員列表哈希/get-employees獲取人員列表信息/get-employees-details獲取人員信息/upload-attendance-record上傳考勤信息/get-upload-attendance-result考勤異步調(diào)用結(jié)果查詢/get-employee-idphoto獲取人員身份證圖片獲取令牌 應用場景獲取訪問接口令牌,用于云服務的其他業(yè)務接口調(diào)用。要求:最快兩次請求間隔1分鐘。輸入?yún)?shù)名稱類型是否必須描述signatureStringY數(shù)據(jù)簽名應用參數(shù)(POST的BODY數(shù)據(jù))名稱類型是否必須描述macStringY考勤設(shè)備唯一maclicenseStringY授權(quán)賬號。由平臺下發(fā)請求url示例https://域名:端口/get-token?mac=xxx&signature=xx請求body示例https://域名:端口/get-token?mac=xxx&signature=xx請求body示例{"license":"ABC055ASQ9D8F7HY5","mac":"123"}返回的JSON數(shù)據(jù)名稱類型是否必須描述codeStringY平臺響應碼,詳見返回碼一覽表messageStringY返回信息dataObjectY返回結(jié)果集成功返回的data結(jié)果集名稱類型是否必須描述tokenStringY服務器生成的通信訪問令牌,有效時長10分鐘。超過10分鐘token失效,需要重新獲取。left_timeIntY顯示通信令牌有效剩余時長(秒返回示例{"code":"00","message":"success","data":{"token":"F2F7A78A741D4N98AC0AB4DAB110PCC8","left_time":600}}獲取心跳 應用場景獲取服務器系統(tǒng)時間,用于同步服務器時間云服務同時獲取當前考勤設(shè)備的心跳。要求:最慢1小時同步一次,最快10分鐘同步一次。輸入?yún)?shù)名稱類型是否必須描述tokenStringY訪問令牌timestampStringYyyyy-MM-ddhh:mm:ss2022-10-0613:52:036signatureStringY數(shù)據(jù)簽名應用參數(shù)(POST的BODY數(shù)據(jù))名稱類型是否必須描述無請求url示例https://域名:端口/get-time?token=xxxx×tamp=xxx&signature=xxx請求body示例無返回的JSON數(shù)據(jù)名稱類型是否必須描述codeStringY平臺響應碼,詳見返回碼一覽表messageStringY返回信息dataObjectY返回結(jié)果集成功返回的data結(jié)果集名稱類型是否必須描述sys_timeStringY(yyyy-MM-ddhh:mm:ss)返回示例{"code":"00","message":"success","data":{"sys_time":"2022-10-0613:52:03"}}獲取人員列表散列值 /get-employees-hash應用場景獲取人員列表散列值,用于檢測人員是否需要更新。token30輸入?yún)?shù)名稱類型是否必須描述tokenStringY訪問令牌timestampStringYyyyy-MM-ddhh:mm:ss2016-06-0613:52:03。服務端允許客戶端請求時間誤差為6分鐘signatureStringY數(shù)據(jù)簽名應用參數(shù)(POST的BODY數(shù)據(jù))名稱類型是否必須描述無請求url示例https:// 域 名 : 端 口/get-employees-hash?token=xxxx×tamp=xxx&signature=xxx請求body示例無返回的JSON數(shù)據(jù)名稱類型是否必須描述codeStringY平臺響應碼,詳見返回碼一覽表messageStringY返回信息dataObjectY返回結(jié)果集成功返回的data結(jié)果集名稱類型是否必須描述emp_countIntY人員數(shù)量sha1StringY人員列表的十六進制小寫散列值返回示例{"code":"00","message":"success","data":{"emp_count":1,"sha1":"xxx"}}獲取人員列表信息 /get-employees應用場景從實名制平臺(V2.0)獲取平臺工程人員列表信息,用于獲取人員列表。要求:兩次最快不低于30分鐘為間隔頻率,獲取人員散列列表值輸入?yún)?shù)名稱類型是否必須描述tokenStringY獲取令牌接口獲取timestampStringYyyyy-MM-ddhh:mm:ss2016-06-0613:52:03。服務端允許客戶端請求時間誤差為6分鐘signatureStringY數(shù)據(jù)簽名應用參數(shù)(POST的BODY數(shù)據(jù))名稱類型是否必須描述sha1StringY人員列表的十六進制小寫散列值請求url示例https:// 域 名 : 端 口/get-employees?token=xxxx×tamp=xxx&signature=xxx請求body示例{"sha1":"abc055asq9d8f7hy5"}返回的JSON數(shù)據(jù)名稱類型是否必須描述codeStringY平臺響應碼,詳見返回碼一覽表messageStringY返回信息dataObjectArrayY返回結(jié)果集成功返回的data結(jié)果集名稱類型是否必須描述idStringY員工idstateStringY工人狀態(tài):presence:表示工人在場狀態(tài);exit:表示工人離場狀態(tài);通過此狀態(tài)可以增加或減少人員updated_atStringY,”yyyy-MM-ddhh:mm:ss.zzz”返回示例{"code":"00","message":"success","data":[{"id":"B06F9F20F70514B7E053020011AC70AA","updated_at":"2022-02-0110:10:10","state":"presence"}]}獲取人員信息 /get-employees-details應用場景從實名制平臺(V2.0)獲取相應人員列表中的人員信息。11000人,否則返回108錯誤碼。輸入?yún)?shù)名稱類型是否必須描述tokenStringY訪問令牌timestampStringYyyyy-MM-ddhh:mm:ss2016-06-0613:52:03時間誤差為6分鐘signatureStringY數(shù)據(jù)簽名應用參數(shù)(POST的BODY數(shù)據(jù))名稱類型是否必須描述employee_listObjectArrayY人員信息數(shù)組idStringY員工id(僅在場狀態(tài)員工)請求url示例https:// 域 名 : 端 口/get-employees-details?token=xxx×tamp=xxx&signature=xxx請求body示例{"employee_list":[{"id":"1"},{"id":"2"}]}返回的JSON數(shù)據(jù)名稱類型是否必須描述codeStringY平臺響應碼,詳見返回碼一覽表messageStringY返回信息dataObjectY返回結(jié)果集成功返回的data結(jié)果集名稱類型是否必須描述idStringY員工id(員工編號)nameStringY員工姓名sexStringY性別ageStringY人員年齡facephotoStringY員工采集照片的urlcompanyStringY所屬單位team_nameStringY班組名稱pass_periodStringY進 場 時 間 , 格 式y(tǒng)yyy-MM-dd:yyyy-MM-ddupdatedStringY修 改 時 間 ,”yyyy-MM-ddhh:mm:ss.zzz”categoryStringY人員類別work_typeStringY人員工種返回示例{"code":"00","message":"success","data":[{"id":"S6FF8GFH9G0JMXNB8DFSG","name":"張三","sex":"男","age":"28",\h"facephoto":"http://xxx/xxx.jpg","company":"中建一局","team_name":"木工組","pass_period":"2022-02-0110:10:10","updated_at":"2022-02-0110:10:10","category":"建筑工人","work_type":"木工"}]}上傳考勤信息 /upload-attendance-record應用場景向?qū)嵜脚_發(fā)送工人考勤通行信息記錄。每次僅限一條通行記錄。1否則返回1008錯誤碼。輸入?yún)?shù)名稱類型是否必須描述tokenStringY訪問令牌timestampStringYyyyy-MM-dd如:2016-06-0613:52:03。服務端允許客6鐘signatureStringY數(shù)據(jù)簽名應用參數(shù)(POST的BODY數(shù)據(jù))名稱類型是否必須描述person_idStringYid(獲取人員信息接口返回的員工編號)passed_timepassed_timeStringY通過考勤時間,格式:yyyy-MM-ddhh:mm:ssdirectionStringY通行方向(in/out)說明:in—進,out—出wayStringY通行方式固定為1—人臉識別site_photoStringYBase64圖像底部帶過閘時間水印50Ksite_photo_hashStringY工地人臉考勤照片md5值longitudeStringN經(jīng)度latitudeStringN緯度temperatureStringN溫度請求url示例https:// 域 名 : 端 /post-attendance-record?token=xxx×tamp=xxx&signature=xxx請求body示例{"project_id":"B06F9F20F70514B7E053020011AC70AA","device_id":"88EE98ACB25D4365A9B8709F78F4F151","person_id":"50B7BBAE68C14A659D26F9B61FFEE28D","passed_time":"2017-03-2912:12:12","direction":"in","way":"1","site_photo":"xxxx","site_photo_hash":"xxxx"}返回的JSON數(shù)據(jù)名稱類型是否必須描述codeStringY平臺響應碼,詳見返回碼一覽表messageStringY返回信息dataObjectY返回結(jié)果集,成功返回的data結(jié)果集名稱類型是否必須描述query_codeStringY異步查詢碼,有效時間1天,用于查詢上報考勤情況返回示例{"code":"00","message":"success","data":{"query_code":"B06F9F20F70514B7E053020011AC70AA"}}失敗返回的data結(jié)果集名稱類型是否必須描述無考勤異步調(diào)用結(jié)果查詢 /get-upload-attendance-result應用場景通過考勤異步查詢碼查詢考勤反饋信息。要求:兩次最快不低于1分鐘為間隔頻率,查詢考勤上報結(jié)果輸入?yún)?shù)名稱類型是否必須描述tokenStringY訪問令牌timestampStringYyyyy-MM-ddhh:mm:ss2016-06-0613:52:03時間誤差為6分鐘signatureStringY數(shù)據(jù)簽名POST的JSON數(shù)據(jù)名稱類型是否必須描述query_codeStringY查詢碼,有效時間1天請求url示例https:// 域 名 : 端 口/get-upload-attendance-result?token=xxx×tamp=xxx&signature=xxx請求body示例{"query_code":"B06F9F20F70514B7E053020011AC70AA"}返回的JSON數(shù)據(jù)名稱類型是否必須描述codeStringY平臺響應碼,詳見返回碼一覽表messageStringY返回信息dataObjectY返回結(jié)果集成功返回的data結(jié)果集名稱類型是否必須描述stateStringY任務狀態(tài):completed:已完成;in-progress:進行中;成功返回示例{"code":"200","message":"調(diào)用成功","data":{"state":"completed"}}失敗返回示例{"code":"1001","message":"錯誤信息","data":{"state":"completed"}}獲取人員身份證圖片 /get-employees-idphoto應用場景通過人員id獲取人員身份證圖片。1拉取1000人,否則返回108錯誤碼。輸入?yún)?shù)名稱類型是否必須描述tokenStringY訪問令牌timestampStringYyyyy-MM-ddhh:mm:ss2016-06-0613:52:03時間誤差為6分鐘signatureStringY數(shù)據(jù)簽名應用參數(shù)(POST的BODY數(shù)據(jù))名稱類型是否必須描述employee_listObjectArrayY人員信息數(shù)組idStringY人員id請求url示例https:// 域 名 : 端 口 /get-employees-idphoto?token=xxx×tamp=xxx&signature=xxx請求body示例{"employee_list":[{"id":"xx"},{"id":"xx"}]}返回的JSON數(shù)據(jù)名稱類型是否必須描述codeStringY平臺響應

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
  • 6. 下載文件中如有侵權(quán)或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論