东莞市建设工程安全监督综合管理平台人脸识别模块数据接口文档.docx
东莞市建设工程安全监督综合管理平台人脸识别模块数据接口文档目录1接口标准31.1 请求方式3调用验证31.2 调用验证的Signature示例3接口 土也址31.3 返回结果4结果代码字典42 获取数据接口方法5获取项目已入场司机GetltemDriver52.1 获取司机照片 GetDriverPhoto6获取项目信息Getltemlnfo73 上传数据接口方法8上传识别记录PostFaceLog81接口标准1.1 请求方式采用Http请求方式，REST风格进行集成接口的访问。按照接口规范拼装一 个正确的URL,通过HTTP请求。获取数据的接口方法通过Get方式请求；上传数据的接口方法通过Post方 式请求。1.2 调用验证给各接口调用方分配各自的Appld与SecretKey,新接入的调用方请联系平 台技术支持单位获取Appld与SecretKeyo每次调用接口，必须传递验证参数Appld （授权id） , TimeSpan （调用接口 的时间戳），Signature （签名），见各接口方法参数字典。Signature为使用 每次调用接口方法时的其他参数生成的32位MD50参数拼接规则如下：SecretKey+AppId+TileSpan+业务参数+SecretKey如果业务参数有多个，按参数字典中的顺序逐个拼接。生成的MD5去掉横杠, 全部使用大写字母。1.3 调用验证的Signature示例以调用GetltemDriver为例，业务参数 DeviceNo： 123456,Appld： DernoAppId,对应密钥：DemoKey, TimeSpan： 07。拼接得到的字符串为： DemoAppId1.4 接口地址测试地址：:7022/ContLift正式地址:参数名称数据类型可空说明Result整型否接口方法请求结果代码，1为成功，其余参见结果 代码字典Message字符串是描述信息Data对象数组是各个方法定义的返回结果对象1.6 结果代码字典结果代码说明0未知错误1成功2Appld不能为空3Appld不存在4Appld未授权访问该接口5调用时间戳不能为空6业务参数不能为空7签名不能为空8签名未通过验证100人脸识别设备唯一编号不能为空101未找到对应编号设备102人脸识别设备未绑定项目200司机身份证号不能为空201未找到对应身份证号司机记录202未找到司机照片文件203司机照片转换失败204该项目无入场司机300操作时间不能为空301识别结果不能为空302识别照片不能为空303识别时间格式不正确304识别结果不在预期取值范围305识别照片转换失败400唯一设备码不能为空401未找到设备码对应的信息2获取数据接口方法2.1 获取项目已入场司机GetltemDriver方法说明获取人脸识别设备所安装工程项目己入场司机，只返回识别设备所安装起重 机械类型的持证司机。所有的司机均会返回，在数据中标记司机是否可用。可根 据返回结果的司机照片文件长度判断是否需要获取司机照片。请求参数参数名称字段名称数据类型可空备注DcviceNo人脸识别设备唯一编号字符串否业务参数Appld授权id字符串否TimeSpan调用接口时间戳格式 yyyyMMddHHmmss字符串否Signature调用接口签.名字符串否2.1.3 返回结果参数名称说明Name司机姓名PhotoLength司机最新照片文件长度IdNo司机身份证号CertNo司机作业证编号CertValidDate司机作业证有效期，格式为yyyy-MM-ddresult:1,message:null,data:(Name: "张三二PhotoLength: 433.2.IdNo: -4420011",CertNo:"粤 SS",CertValidDate: "2021-12-12").(Name: "李四:PhotoLength: 533.2,IdNo: -4420025", CertNo:"粤 TST". CertValidDate: "2021-12-12")2.2 获取司机照片GetDriverPhoto方法说明根据司机身份证号获取司机照片。2.2.1 请求参数参数名称字段名称数据类型可空备注IdNo司机身份证号字符串否业务参数Appld授权id字符串否TimeSpan调用接口时间戳格式 yyyyMMddHHmniss字符串否Signature调用接口签名字符串否2.2.2 返回结果参数名称 |说明IdNo司机身份证号PhotoLength照片文件长度Photo司机照片正确返回示例result:1, messagemull, data:(IdNo: "4420011",PhotoLength: 433.2, Photo:base64 图片数据. )2.3 获取项目信息Getltemlnfo方法说明根据设备唯一编号获取项目信息。2.3.1 请求参数参数名称字段名称数据类 型可空备注DeviceNo设备唯一编号字符串否业务参数Appld授权id字符串否TimeSpan调用接口时间戳格式 yyyyMMddHHmmss字符串否Signature调用接U签名字符串否2.3.2 返回结果参数名称说明ItemName项目名称ShortName所属镇区Crancno起重机械产权备案号2.3.3 正确返回示例"resulfl."message":"成功， “data”:（“ItemName"测试项目”,"ShortName":"厚街镇”, "Craneno":" SA-T02053" ）3上传数据接口方法3.1 上传识别记录PostFaceLog方法说明上传人脸识别设备的识别记录。识别照片需要控制在1M之内。3.1.1 上传参数参数名称字段名称数据类型可空备注DeviceNo识别设备唯一编号字符串否业务参数IdNo进行识别人员的身份证号字符串是业务参数 识别结果为 1的记录必 填Operate?ime识别时间，格式： yyyy-MM-dd Hlknun: ss字符串否业务参数Result识别结果,0为失败，1为 成功字符串否业务参数Photo识别时的照片Base64 照 片数据否业务参数Apple!授权id字符串否TimeSpan调用接口时间戳格式 yyyyMMddHHmmss字符串否Signature调用接口签名字符串否3.1.2 上传数据示例DeviceNo: "T20201212”，IdNo: "4420011”，OperateTime: "2020-12-12 16:32:36",Result: 1,Photo: base64图片数据)返回结果示例result!.message:"上传成功二 data:null
