以下为《全国劳动保障实名制标准接口文档 2001-1》的无排版文字预览,完整内容请下载
目 录
1概述 3
简介 3
适用对象及场景 3
基本术语 3
接口响应统一返回参数结构 5
接口类型 6
异步处理接口 6
同步处理接口 7
2接口详细信息 8
数据处理规则 8
数据格式问题 8
数据更新问题 8
2.1企业 9
上传企业基本信息 9
查询企业基本信息 12
2.2项目 15
2.2.1项目基本信息 15
2.2.2项目参建单位 22
2.2.3项目班组 28
2.2.4项目人员OK 35
2.2.5项目人员在离职 44
2.2.6项目人员合同 50
2.2.7项目人员考勤 56
2.3人员 61
查询人员基本信息(暂无) 61
2.4异步接口调用结果查询 63
接口信息说明 63
数据字典 65
行政区划字典表 65
响应状态字典表 66
项目状态字典表 66
参建单位类型字典表 66
工人工种字典表 66
银行代码字典表 68
是否字典表 69
工人考勤方向字典表 70
工人在离职类型字典表 71
计量单位类型字典表 71
性别字典表 71
政治面貌字典表 71
文化程度 72
婚姻状况 72
工人类型字典表 74
4.15异步处理结果状态字典表 74
版本
作者
时间
备注
V1.0
易某某
2020/02/26
初稿
V1.1
毕某某
2020/04/09
修改
1概述
简介
全国劳动保障实名制标准开放式接口OpenAPI主要为第三方服务商与劳动保障监察平台进行数据交互使用;所有API均基于Post方式请求调用。
第二期提供对接步骤相应管理后台。
适用对象及场景
适用范围
工程建设领域。
适用对象
第三方自建实名制管理平台(以下简称自平.建台),包括政府平台、企业级平台、硬件厂家平台。
场景
使用劳动保障监察平台以及考勤设备,自平.建台通过接口获取相关数据;
使用自平.建台以及自有考勤设备,自平.建台通过接口推送相关数据;
对接步骤
自平.建台方联系当地劳动保障监察局提出申请,由劳动保障监察局向平台建设方发需求函,平台建设方提供对接文档,由自平.建台主动完成对接。
获取、推送数据流程
必须严格按照该流程推送或获取数据,否则会造成数据获取或推送失败;
/
其中企业数据、项目数据、参建单位数据为必填项,后续其他数据更新可单独获取或推送。
基本术语
接口提供方(API Provider):接口的定义和实现者,为接口调用方提供接口合法访问的授权。
接口调用方(API Client):接口的调用者,需要从接口提供方获得所需接口合法访问的授权。
接口端点(API Endpoint):接口的Http资源入口,由一个Http URL所表示,代表了一个或由参数确定的多个接口的集合。
接口调用方式
POST 格式为:POST
参数列表
参数列表格式为:参数名 1=参数值 1&参数名 2=参数值 2……
请求标准参数
参数名称
参数说明
method
由接口提供方指定的接口标识符。
version
由接口提供方指定的接口版本。注:Endpoint+ method+version 决定了接口的语义。
appId
由接口提供方分配给接口调用方的身份标识符。
format
接口返回结果类型:json
timestamp
调用方时间戳,格式为“4 位某某+2 位某某+2 位某某+2 位小时(24 小时制)+2 位某某+2 位某某”,用于接口提供方判断调用方的时间,通常约定调用请求的时间戳与接口提供方收到请求的时间差在约定的范围内。
nonce
6位随机数,由调用方某某,在约定的调用时差范围内不可重复。
sign
签名,按照签名生成算法计算得来。
data
具体的接口方法中的参数实体信息(对象需要转换成 JSON
String)
企业签名流程如下
申请企业秘钥
敏感信息(银行卡号,证件号码和企业签名等)需要加密传输,请使用 AES加密,
算法说明: 算法密钥=接入密钥 KEY, 编码=UTF8,加密模式(CipherMode)=CBC,填充模式(PaddingMode)=PKCS7, 数据块大小(BlockSize)=128,
算法的初始化向量(IV)= 接入密钥 KEY 的前 16 位字符,加密后的字节数组转为 Base64 字符串,需要加密的字段会在字段备注中添
加‘AES’标记。算法:密文=Base64(AES(info, KEY))。详细的算法代码示例可以在测试平台的资料下载模块下载到。
请求样例:
RequestBody: method=employee.create&format=json&version=1.0&appId=appcode123&tim estamp=20***0&nonce=321431&sign=***dc822216fdded329361f4
311ea9f&data={"phone": ["***","***"],"name": "zhangsan","age":
100,"address": {"country": "china","province": "chengdu"},"married": false}
接口响应统一返回参数结构
参数名称
参数说明
code
处理结果编码(参考下面的“标准错误代码定义”)
message
处理结果消息
data
接口处理完毕返回的数据(请参见具体接口的返回信息)。
返回的 Json 格式:
{"code":"0","message":"","data":{ "phone":["***","***"],"name":
"zhangsan"}}
标准 Code 代码定义,详情见字典表:响应状态字典
注:标准错误码小于 0,大于 0 的错误码由各接口根据接口语义自行定义
接口参数签名sign方法
(1)第一步:拼接参数字符串
将除 sign 以外的请求参数(包括标准参数,除非有特别说明)按照参数名
称的字典升序排列,然后按此顺序,将”参数名=参数值”用”&”符号连接。示例:
appId=appcode123&data={"phone":["***","8765
4321"],"name":
"zhangsan","age":30,"address":{"country":"china","province":"chengdu"},"married":f alse}&format=json&method=employee.create&nonce=***×tamp=20160
***0&version=2.0 注意事项:
1) data 参数必须转换为 JSON 格式的字符串。
2) 仅对接口定义中声明且请求参数列表中包含的参数(包括空值)进行签名。
3) 参数值不作去除空格。
(2) 第二步:在拼接参数字符串后再拼接&appsecret,如
&appsecret=df23hlir85353;appsecret 即密钥,由和谐用工平台技术支持人员提供。
示例:
appId=appcode123&data={"phone":["***","***"],"name":
"zhangsan","age":100,"address":{"country":"china","province":"chengdu"},"married"
:false}&format=json&method=employee.create&nonce=***×tamp=2016
***00&version=2.0&appsecret=df23hlir85353gfgd86775jjdh6322
(3) 第三步:将上一步的获得的字符串全部转换为小写。再进行 SHA256 加密(SHA256 64 位),生成的字符串就是验签数据 sign。注意:SHA256 加密哈希值请转换为 16 进制表示。
OpenAPI 对验签数据 sign 进行校验时不区分大小写。
访问频率限制
OpenAPI 对访问过于频繁等情况做了屏蔽处理,针对同一调用方(API Client) 访问同一方法这一级别可以做如下限制: 访问时间间隔不能少于 1 秒,且不允许并发(即上一次访问还没有返回结果就开始下一次访问);具体访问限制参数可配置,会根据上线后实际业务数据量和访问频率做优化调整。
接口类型
异步处理接口
异步处理接口是指调用之后不会立即返回处理结果,而是返回响应体字段 requestSerialCode供后续查询使用。可通过异步接口调用结果查询进行结果查询,其返回内容可参考每一接口的异步处理结果响应体字段部分,若异步处理结果响应体字段部分没有任何内容,则表明该异步处理不返回任何额外信息,仅需关注异步处理状态即可;上传接口为异步处理接口;具体流程图如下:
/
同步处理接口
同步处理接口是指调用之后立即返回处理结果,查询接口都是同步处理接口;返回的内容在每一查询接口的‘响应体字段’中进行描述。在具体调用流程图如下:
/
2接口详细信息
数据处理规则
数据格式问题
需校验统一社会信用代码、身份证号码、手机号码基本格式,如格式不正确,则拒绝接收数据并返回错误原因;
数据更新问题
接收自平.建台数据时,仅作信息完善操作。
2.1企业
2.1.1上传企业基本信息
接口信息
Endpoint
https://{host}/open/api/get
Method
Corp.Upload
Version
1.0
返回方式
响应体(JSON)
接口说明
上传企业基本信息
输入参数
名称
类型
是否必需
备注说明
corpCode
String
是
企业统一社会信用代码
corpName
String
是
企业名称
areaCode
String
是
Type
String
是
公司类型。参考参建单位类型字典表
registerAddress
String
否
注册地 ,可为空值
Address
String
是
单位地址
String
否
legalMan
String
是
法人姓名
legalManTel
String
是
法人联系方式
linkman
String
否
联系人 ,可为空值
linkTel
String
否
联系人电话 ,可为空值
remark
String
否
备注
异步处理结果响应体字段
名称
类型
是否必需
备注
requestSerialCode
string
是
请求序列编码
请求体格式示例
{
"corpCode": "9***357147",
"corpName": "0810-劳务分包01",
"areaCode": "350423",
"registerAddress": "XX县龙津镇XX花园6幢1305室",
"address": "XX县龙津镇XX花园6幢1305室",
"email": "t@126.com",
"legalMan": "张三",
"legalManTel": "***",
"linkMan": "李数",
"linkTel": "***",
"remark": "备注",
"type": "01"
}
响应体格式示例
{
"data": {
"requestSerialCode": null
},
"code": "0",
"message": "调用成功"
}
2.1.2查询企业基本信息
接口信息
Endpoint
https://{host}/open/api/get
Method
Corp.Query
Version
1.0
返回方式
响应体(JSON)
接口说明
查询调取企业基本信息
输入参数
名称
类型
备注说明
pageIndex
int
指定页号,以0为起始数字,表示第1页
pageSize
int
每页记录数,最多不能超过50
corpName
String
企业名称,与统一社会信用代码必传一个
corpCode
String
统一社会信用代码,与企业名称必传一个
响应体字段
名称
类型
备注说明
totalCount
int
记录总数
pageIndex
int
指定页号,以 1为起始数字,表示第 1 页
pageSize
int
每页记录数,最多不能超过 50
rows
String
记录集合。JSON 数组
数组内对象字段
名称
类型
备注说明
corpCode
String
企业统一社会信用代码
corpName
String
企业名称
areaCode
String
企业注册地区编码。参考行政区划字典表
registerAddress
String
注册地
address
String
单位地址
String
legalMan
String
法人姓名
legalManTel
String
法人联系方式
linkman
String
联系人
linkTel
String
联系人电话
remark
String
备注
请求体格式示例
{
"corpName": "",
"corpCode": "",
"pageIndex": 0,
"pageSize": 10
}
响应体格式示例
{
????"data":{
????????"rows":[
????????????{
????????????????"corpCode":"9***357147",
????????????????"corpName":"0810-劳务分包01",
????????????????"areaCode":"350423",
????????????????" registerAddress ":"龙津镇XX花园6幢1305",
????????????????"address":"XX县龙津镇XX花园6幢1305室",
????????????????"email":"t@126.com",
????????????????"legalMan":"张三",
????????????????" legalManTel ":"***",
????????????????"linkMan":"李数",
????????????????"linkTel":"***",
????????????????"remark":"备注",
????????????????"type":"01"
????????????}
????????],
????????"totalCount":100,
????????"pageIndex":0,
????????"pageSize":10
????},
????"code":"0",
????"message":"调用成功"
}
2.2项目
2.2.1项目基本信息
上传项目信息
接口信息
Endpoint
https://{host}/open/api/get
Method
Project.Upload
Version
1.0
返回方式
响应体(JSON)
接口说明
上传项目信息及更新项目信息
输入参数
名称
类型
是否必需
备注说明
contractorCorpCode
String
是
施工方统一社会信用代码
contractorCorpName
String
是
施工方名称
name
String
是
项目名称
buildCorpName
String
是
建设方名称
buildCorpCode
String
是
建设方统一社会信用代码
areaCode
String
是
所属区域。参考行政区划字典表
invest
BigDecimal
是
工程造价,单位:(元)
startDate
String
是
开工日期,精确到天,格式:yyyy-MM-dd
timeLimit
int
是
建设周期,单位:(天)
linkMan
String
否
项目办理人姓名
linkTel
String
否
联系方式
prjStatus
String
是
项目状态。参考项目状态字典表
lat
String
是
WGS84经度
lng
String
是
WGS84纬度
address
String
是
项目地址
salaryDay
int
否
工资发放日 ,可为空值(1-31)
type
String
是
项目类型。(新加字段)参考项目类型字典表
investment
String
是
投资类别。(新加字段)参考项目投资类别字典表
industry
String
是
行业。(新加字段)参考项目行业字典表
响应体字段
名称
类型
备注说明
requestSerialCode
String
请求序列编码
异步处理结果响应体字段
名称
类型
备注说明
projectCode
String
本平台分配的项目ID
请求体格式示例
查询项目信息
接口信息
Endpoint
https://{host}/open/api/get
Method
Project.Query
Version
1.0
返回方式
响应体(JSON)
接口说明
查询调取项目信息
输入参数
名称
类型
备注说明
pageIndex
int
指定页号,以1为起始数字,表示第1页
pageSize
int
每页记录数,最多不能超过50
projectCode
String
本平台分配的项目ID
buildCorpName
String
施工方企业名称,与统一社会信用代码必传一个
buildCorpCode
String
施工方统一社会信用代码,与企业名称必传 内容过长,仅展示头部和尾部部分文字预览,全文请查看图片预览。 铁路工程
05
公路工程
06
XX与航道工程
07
水利水电工程
08
电力工程
09
矿山工程
10
冶炼工程
11
化工石油工程
12
通信工程
99
其他
投资类别字典表
编码
类型
GOV
政府投资
NOT_GOV
非政府投资
GOV_AND_SOCIETY
政府与社会共筹
OTHERS
其他
行业类型字典表
编码
类型
01
住建
02
交通
03
水利
04
水电
05
国土
06
教育
07
财政
08
经信
09
通信
10
烟草
11
安监
12
旅游
13
电力
14
农业
15
公路
16
房管局
17
城投
18
港航局
19
高标办
20
发改
21
公安
22
铁路
23
科技城
24
易迁办
25
农业农村
26
自然资源
[文章尾部最后500字内容到此结束,中间部分内容请查看底下的图片预览]请点击下方选择您需要的文档下载。
以上为《全国劳动保障实名制标准接口文档 2001-1》的无排版文字预览,完整内容请下载
全国劳动保障实名制标准接口文档 2001-1由用户“阿拉木哒”分享发布,转载请注明出处