附件二:
建筑工人管理服务信息
数据对接标准
2018年12月
版本修改记录
版本 | 修改记录 | 日期 | 修改人 |
V_1.0 | 基础版本 | 2018-12 | 陈石杨 |
V_1.1 | 签名signature生成规则调整 | 2019-09 | 陈石杨 |
V_1.2 | 增加查询项目接口 | 2020-05 | 陈石杨 |
V_1.2 | 工种数据字典数据修改(删除管理人员工种,增加住建部新增的工种(总包参建单位类型的)) | 2020-11 | 陈石杨 |
采用Http请求方式,REST风格进行集成接口的访问。按照接口规范拼装一个正确的URL,通过HTTP请求。
1.1.2 调用方式说明URL地址 | http://xxx.com/yyyyService/APIfunction?api_key=x1&api_version=x2×tamp=x3&signature=x4 |
Encoding | UTF-8 |
Method | POST |
Body | JSON数据 |
返回 | JSON数据 |
调用API ,必须传入系统参数和应用参数。
api_key | String | Y | 授权帐号 |
api_version | String | Y | API协议版本,可选值:1.0 |
timestamp | String | Y | 时间戳,格式为yyyy-MM-dd hh:mm:ss,例如:2016-06-06 13:52:03。服务端允许客户端请求时间误差为6分钟 |
signature | String | Y | 对API输入参数进行MD5加密获得 |
应用参数放在body数据区
1.1.3.3 签名signature使用系统默认MD5加密,因为各语言语法不一致,以下实例只体现逻辑。为便于说明,假设 api_secret和api_key均为 test。body区的数据项对应的json key为”body”, value为整个body原始字符串。
1)所有参数为:(如果新增参数,请按照此规则) api_key=test api_version=1.0 timestamp=2016-06-10 09:05:03 body={client_version:1.1.0.0} 2)按照参数名称升序排列: api_version=1.0 body={client_version:1.1.0.0} timestamp=2016-06-10 09:05:03 3)连接字符串 连接参数名与参数值,并在首尾加上api_secret,如下: testapi_keytestapi_version1.0body{client_version:1.1.0.0} timestamp2016-06-10 09:05:03test 4)生成签名: 32位大写MD5值-<XXXXXXXXXXXXXXXXXXXX 5)拼装HTTP请求 将所有参数值转换为UTF-8编码,然后拼装,通过浏览器访问该地址,即成功调用一次接口。 |
所有的请求和响应数据编码皆为utf-8格式,url里的所有参数值请做urlencode编码,如body为空请用“body{}”进加密, POST请求的content-type为“text/html;charset=UTF-8”。
1.1.4 返回参数result | String | 是 | 接口调用结果。true表示接口调用成功,false表示接口调用失败。 | |||
message | String | 否 | 错误信息 | |||
detail_message | String | 否 | 详细错误信息 | |||
result_data | Object | 是 | 返回结果集 | |||
成功返回的result_data结果集 | ||||||
名称 | 类型 | 是否必须 | 描述 | |||
调用示例
请求示例(注意事项:非必填字段也要传,可传空值,数据类型要匹配,例如数字类型不可传空字符串) | |
请求URL | /UploadSmz/UploadCompanyInfo?api_key=test&signature=2A1C0A69BF2F073671B2E4502F7748B8&api_version=1.0×tamp=2019-08-21+17%3A46%3A06 |
Post Json | {"corpCode":"888888888888888888","corpName":"测试企业","corpType":null,"licenseNum":null,"areaCode":"330783","address":null,"zipCode":null,"legalMan":null,"legalManDuty":null,"legaManProTitle":null,"legalManIDCardType":null,"legalManIDCardNumber":null,"regCapital":null,"factRegCapital":null,"registerDate":"1998-04-03","establishDate":null,"officePhone":null,"faxNumber":null,"linkman":null,"linkTel":null,"email":null,"website":null,"remark":null} |
返回示例 | |
Return Json | {"result":"true","message":"","result_data":""} |
实名制平台提供的初始化服务
1.2.1 行政区划字典按照《中华人民共和国行政区划代码》GB/T 2260-2015规定的行政区划名称及代码
1.2.2 基础数据字典类型类型(type(int)) | 描述 |
1 | 单位性质 |
2 | 人员证件类型 |
3 | 注册资本币种 |
4 | 项目分类 |
5 | 项目状态 |
6 | 立项级别 |
7 | 建设规模 |
8 | 建设性质 |
9 | 工程用途 |
10 | 参建类型 |
11 | 人员工种 |
12 | 工人类型 |
13 | 银行代码 |
14 | 政治面貌 |
15 | 文化程度 |
16 | 婚姻状况 |
17 | 工人进退场类型 |
18 | 合同期限类型 |
19 | 计量单位 |
20 | 刷卡进出方向 |
21 | 通行方式 |
22 | 培训类型代码 |
应用场景 | |||
根据类型获取所有基础数据字典,通过验证后获得对应的数据字典编码。 | |||
输入参数 | |||
名称 | 类型 | 是否必须 | 描述 |
api_key | String | 是 | 授权帐号 |
api_version | String | 是 | API协议版本,可选值:1.0 |
timestamp | String | 是 | 时间戳,格式为yyyy-MM-dd hh:mm:ss,例如:2016-06-06 13:52:03。 |
signature | String | 是 | 对API输入参数进行MD5加密获得 |
POST的JSON数据 | |||
名称 | 类型 | 是否必须 | 描述 |
type | Int | 是 | 参考国标(基础数据字典类型) |
成功返回的result_data结果集 | |||
名称 | 类型 | 是否必须 | 描述 |
orders | int | 是 | 编码 |
value | String | 是 | 名称 |
API接口名称 | API描述 |
/UploadSmz/UploadCompanyInfo | |
/UploadSmz/UploadItemInfo | |
/UploadSmz/UploadParticipateInfo | |
/UploadSmz/UpdateParticipateInfo | |
/UploadSmz/UploadTeamInfo | |
/UploadSmz/UpdateTeamInfo | |
/UploadSmz/UploadRosterInfo | |
/UploadSmz/UpdateRosterInfo | |
/UploadSmz/UploadEntryExitInfo | |
/UploadSmz/UploadContract | |
/UploadSmz/UploadPayroll | |
/UploadSmz/UploadPayrollDetail | |
/UploadSmz/UploadTrainInfo | |
/UploadSmz/UploadTrainWorkerInfo | |
/UploadSmz/UploadDeviceInfo | |
/UploadSmz/GetItemInfo | |
/UploadSmz/GetTeamInfo |
应用场景 | |||
输入参数 | |||
名称 | 类型 | 是否必须 | 描述 |
api_key | String | 是 | 授权帐号 |
api_version | String | 是 | API协议版本,可选值:1.0 |
timestamp | String | 是 | 时间戳,格式为yyyy-MM-dd hh:mm:ss,例如:2016-06-06 13:52:03 |
signature | String | 是 | 对API输入参数进行MD5加密获得 |
POST的JSON数据 | |||
名称 | 类型 | 是否必须 | 描述 |
corpCode | string | 是 | 企业统一社会信用代码或者组织机构码 |
corpName | string | 是 | 企业名称 |
corpType | int | 否 | 单位性质。参考国标(基础数据类型数据字典) |
licenseNum | string | 否 | 工商营业执照注册号 |
areaCode | string | 是 | 企业注册地区编码。参考国标(行政区划字典) |
address | string | 否 | 企业营业地址 |
zipCode | string | 否 | 邮政编码 |
legalMan | string | 否 | 法定代表人姓名 |
legalManDuty | string | 否 | 法定代表人职务 |
legaManProTitle | string | 否 | 法定代表人职称 |
legalManIDCardType | int | 否 | 法定代表人证件类型。参考国标(基础数据类型数据字典) |
legalManIDCardNumber | string | 否 | 法定代表人证件号码。 |
regCapital | decimal | 否 | 注册资本(万元,可保留4位小数) |
factRegCapital | decimal | 否 | 实收资本(万元,可保留4位小数) |
registerDate | string | 是 | 注册日期,格式yyyy-MM-dd |
establishDate | string | 否 | 成立日期,格式yyyy-MM-dd |
officePhone | string | 否 | 办公电话 |
faxNumber | string | 否 | 传真号码 |
linkman | string | 否 | 联系人姓名 |
linkTel | string | 否 | 联系人办公电话 |
string | 否 | 企业联系邮箱 | |
website | String | 否 | 企业网址 |
remark | String | 否 | 企业备注 |
应用场景 | ||||||
输入参数 | ||||||
名称 | 类型 | 是否必须 | 描述 | |||
api_key | String | 是 | 授权帐号 | |||
api_version | String | 是 | API协议版本,可选值:1.0 | |||
timestamp | String | 是 | 时间戳,格式为yyyy-MM-dd hh:mm:ss,例如:2016-06-06 13:52:03 | |||
signature | String | 是 | 对API输入参数进行MD5加密获得 | |||
POST的JSON数据 | ||||||
名称 | 类型 | 是否必须 | 描述 | |||
projectCode | String | 否 | 项目统一编号(修改项目信息时必填) | |||
contractorCorpCode | string | 是 | 总承包单位统一社会信用代码,如果无统一社会信用代码,则填写组织机构代码 | |||
contractorCorpName | string | 是 | 总承包单位名称 | |||
name | string | 是 | 项目名称 | |||
description | string | 否 | 项目简介 | |||
category | int | 是 | 项目分类。参考国标(基础数据类型数据字典) | |||
buildCorpName | string | 否 | 建设单位名称 | |||
buildCorpCode | string | 否 | 建设单位统一社会信用代码,如果无统一社会信用代码,则填写组织机构代码 | |||
builderLicenses | array | 是 | 施工许可证。JSON数组 | |||
buildPlanNum | string | 否 | 建设用地规划许可证编号。 | |||
prjPlanNum | string | 否 | 建设工程规划许可证编号。 | |||
areaCode | string | 是 | 项目所在地。。参考国标(行政区划字典) | |||
invest | decimal | 否 | 总投资,单位:(万元)(最多精确到4位小数) | |||
buildingArea | decimal | 否 | 总面积,单位:平方米(最多精确到2位小数) | |||
buildingLength | decimal | 否 | 总长度,单位:米(最多精确到2位小数) | |||
startDate | string | 否 | 开工日期,精确到天,格式:yyyy-MM-dd | |||
completeDate | string | 否 | 竣工日期,精确到天,格式:yyyy-MM-dd | |||
linkMan | string | 否 | 联系人姓名 | |||
linkPhone | string | 否 | 联系人办公电话 | |||
prjStatus | int | 是 | 项目状态。参考国标(基础数据类型数据字典) | |||
lat | decimal | 否 | WGS84经度(精确到15位小数) | |||
lng | decimal | 否 | WGS84纬度(精确到15位小数) | |||
address | string | 否 | 项目地点 | |||
approvalNum | string | 否 | 立项文号 | |||
approvalLevelNum | int | 否 | 立项级别。参考国标(基础数据类型数据字典) | |||
prjSize | int | 否 | 建设规模。参考国标(基础数据类型数据字典) | |||
propertyNum | int | 否 | 建设性质。参考国标(基础数据类型数据字典) | |||
functionNum | int | 否 | 工程用途。参考国标(基础数据类型数据字典) | |||
thirdPartyProjectCode | string | 是 | 供应商为项目创建的编码,同一个系统不能重复编码 | |||
builderLicenses数组对象相关字段 | ||||||
名称 | 类型 | 是否必须 | 描述 | |||
prjName | string | 是 | 工程名称 | |||
builderLicenseNum | string | 是 | 施工许可证编号。 | |||
成功返回的result_data结果集 | ||||||
名称 | 类型 | 是否必须 | 描述 | |||
projectCode | String | 是 | 项目统一编号 |
应用场景 | |||||||
输入参数 | |||||||
名称 | 类型 | 是否必须 | 描述 | ||||
api_key | String | 是 | 授权帐号 | ||||
api_version | String | 是 | API协议版本,可选值:1.0 | ||||
timestamp | String | 是 | 时间戳,格式为yyyy-MM-dd hh:mm:ss,例如:2016-06-06 13:52:03 | ||||
signature | String | 是 | 对API输入参数进行MD5加密获得 | ||||
POST的JSON数据 | |||||||
名称 | 类型 | 是否必须 | 描述 | ||||
projectCode | string | 是 | 项目编码 | ||||
corpCode | string | 是 | 统一社会信用代码,如果无统一社会信用代码,则填写组织机构代码 | ||||
corpName | string | 是 | 企业名称 | ||||
corpType | int | 是 | 参建类型。参考国标(基础数据类型数据字典) | ||||
entryTime | string | 否 | 进场时间。格式yyyy-MM-ddHH:mm:ss | ||||
exitTime | string | 否 | 退场时间。格式yyyy-MM-ddHH:mm:ss | ||||
bankInfos | array | 否 | 发放工资的银行。JSON数组 | ||||
pmName | string | 否 | 项目经理名称 | ||||
pmIDCardType | int | 否 | 项目经理证件类型。参考国标(基础数据类型数据字典) | ||||
pmIDCardNumber | string | 否 | 项目经理证件号码。 | ||||
pmPhone | string | 否 | 项目经理电话 | ||||
bankInfos数组对象相关字段 | |||||||
名称 | 类型 | 是否必须 | 描述 | ||||
bankCode | int | 是 | 银行代码。参考国标(基础数据类型数据字典) | ||||
bankName | string | 是 | 银行支行名称 | ||||
bankNumber | string | 是 | 银行卡号。 | ||||
bankLinkNumber | string | 是 | 银行联号 |
部分内容由用户投稿或者来源于网络,如有侵权,请联系底部邮箱进行删除!非常感谢您的支持!