灵工SAAS平台OpenAPI2.0文档
  1. 灵活用工
灵工SAAS平台OpenAPI2.0文档
  • 灵活用工
    • 前言
    • 流程说明
    • 对接说明
    • 通知说明
    • 示例代码
    • 自由职业者
      • 实名认证(SFT0101)
      • 实名认证+合同综合接口(SFT0109)
      • 身份证照片上传(SFT0102)
      • 自由职业者信息查询(SFT0103)
      • 银行卡bin查询(SFT0202)
      • 银行卡列表(SFT0201)
      • 银行卡绑定(SFT0203)
      • 银行卡解绑(SFT0204)
      • 自由职业者身份证图片获取(SFT0110)
    • 电子合同
      • 合同预览(SFT0107)
      • 电子合同生成(SFT0104)
      • 电子合同授权签约(SFT0105)
      • 电子合同信息查询(SFT0106)
      • 电子合同上传(待开发)
      • 自由职业者电子合同查询(SFT0111)
    • 存管账户
      • 服务商列表(SFT0301)
      • 账户列表查询(SFT0302)
      • 账户余额查询(SFT0303)
      • 充值账户查询(SFT0304)
      • 企业银行账户列表(SFT0310)
      • 企业银行账户绑定(SFT0311)
      • 企业银行账户解绑(SFT0312)
      • 账户变动明细(SFT0305)
    • 充值
      • 充值记录查询(SFT0401)
      • 充值申请(待开发)
      • 充值订单查询(SFT0403)
      • 充值数据同步(SFT0404)
    • 用工企业提现
      • 提现订单列表(SFT0411)
      • 提现申请(SFT0412)
      • 提现订单详情(SFT0413)
    • 自由职业者佣金结算
      • 佣金结算服务费预计算(SFT0501)
      • 佣金结算(SFT0502)
      • 佣金结算批次查询(SFT0503)
      • 佣金结算批次订单查询(SFT0504)
      • 佣金结算订单查询(SFT0505)
      • 电子回单查询(SFT0506)
      • 佣金结算数据同步(SFT0510)
    • 退款
      • 退款订单查询(SFT0801)
      • 退款订单明细(SFT0802)
    • 开票
      • 开票类目查询(SFT0601)
      • 开票类型列表(SFT0602)
      • 可开票批次查询(SFT0603)
      • 开票申请(SFT0605)
      • 开票申请列表(SFT0606)
      • 开票申请详情(SFT0607)
      • 开票申请关联订单列表(SFT0608)
      • 开票额度账户列表(SFT0609)
      • 开票额度账户详情(SFT0610)
      • 开票申请撤销(SFT0611)
    • 项目
      • 项目列表(SFT0701)
      • 项目详情(SFT0702)
      • 项目新增(SFT0703)
      • 项目删除(SFT0704)
      • 项目确认单(SFT0705)
    • 完税凭证
      • 完税凭证记录(SFT1001)
    • 通知
      • 充值通知(1001)
      • 提现通知(2001)
      • 佣金结算通知(3001)
      • 佣金结算退票通知(5001)
      • 电子合同签约完成通知(8001)
      • 开票结果通知(9001)
    • 企业信息
      • 企业信息查询(SFT0901)
  • 营销金结算
    • 营销活动
      • 营销活动创建(SFT1101)
    • 结算
      • 营销金结算付款(SFT0502)
      • 营销金结算批次查询(SFT0503)
      • 营销金结算批次订单查询(SFT0504)
      • 营销金结算订单同步(SFT0510)
  1. 灵活用工

对接说明

接入模式#

api分大商户、普通商户两种模式,主要区别如下
大商户模式:
贵平台提供SAAS技术服务服务不同的用工企业
普通商户模式:
贵平台既用工企业
大商户只提供一套密钥,后续入网商户提供商户号

接入前提#

接入企业需要线下配合我司平台运营完成入网签约,再由我司技术配置商户参数给到贵司技术,完成RSA密钥交换

接口说明#

1.接口使用统一的url地址
2.请求/响应Content-Type使用application/json
3.接口请求加解密方式,使用平台公钥对bizModel报文加密, 使用商户私钥进行sign加签
📌
密钥位数:1024
填充方式:PKCS8
在线生成地址:https://www.bejson.com/enc/rsa/
注意:RSA公私钥经过base64编码,不同开发语言下,注意进行解码
4.提现、充值、付款、退票、开票、合同签约场景支持通知, 具体查看通知说明通知接口说明
5.如果接入的是银行通道,需要考虑退票场景,退票场景主要为佣金结算通知付款成功后,银行收到对方行退票,导致成功的订单变为失败
📌
如贵司使用的是java开发语言,我司提供SDK包,其它开发语言因技术原因暂不提供,具体实现参考接口说明
下载地址:https://tax-plan-prod.oss-cn-shenzhen.aliyuncs.com/public/openapi/tax-plan-open-api-2.0-20241121.jar
测试地址: http://api.test.taxll.com/
正式地址: https://api.taxll.com/
sign加签说明
参与签名参数和示例值
1.
接口编码 如:apiCode=SFT0101 参考接口说明
2.
商户号 如:merchantNo=1000001 平台分配给用工企业的商户号
3.
时间戳 如:timestamp=20210101010101 当前时间戳 格式:yyyyMMddHHmmss
4.
请求流水 如:requestNo=abcs111111111 自己生成便于后续查询日志
5.
接口版本 如:version=2.0 固定值2.0
6.
接口参数对象 如:bizModel=接口参数对象转换为json字符串后使用平台RSA公钥加密的值, 如接口要求不加密则为接口参数对象json格式后的字符串,为空不加密但是需要空字符串
SIGN规则说明
1.
bizModel为接口参数转成json字符串,使用平台RSA公钥加密的值
2.
加签参数apiCode,merchantNo,requestNo,timestamp,version,bizModel排序后,按key=value&key=value 拼接
💡
拼接sing字符串示例值: apiCode=SFT0204&bizModel=huV9ooXRlLNd1EEsU212ZPbFB/XTSvKYaocqmh3ToFmcI3PE186CK0jB6BkD3CV4E/C9qRiVQmZEw17pmbvLsuP0UCJ3ZXvxoloMTmBPljj4vBAZWcn0B1bJcTFaW+AW5/MbeQULDZsZac9S4TW+d7JTrlI8/5kOcKWMZ89pYuY=&merchantNo=1088202103120003&requestNo=55fa621c-b8f7-473f-8f0e-8c634d6d2925&timestamp=20240108151819&version=2.0
3.
拼接后的字符串,使用商户RSA私钥签名生成sign值,签名规则:
💡
1) 使用MD5withRSA算法完成签名
2) 签名后使用base64算法进行编码

请求参数#

参数字段参数说明数据类型是否必传
apiCode接口编码,具体查看接口说明string是
merchantNo商户号,平台分配string是
requestNo请求流水,自定义string是
timestamp请求时间戳,格式:yyyyMMddHHmmss,平台会进行重放请求校验string是
version接口版本,默认2.0string否
bizModel接口参数对象,具体查看接口说明,接口参数根据接口说明要求需要进行加密object是
📌
1.接口参数bizModel加密前为json格式字符串(参数值参考接口说明),json字符串使用平台RSA公钥加密
2.接口请求示例中bizModel都是明文,实际请求时需要进行RSA加密
注:bizModel参数传空字符不进行RSA加密,接口会基于校验规则校验接口参数
📌
bizModel请求报文RSA加密规则(平台RSA公钥加密):
1.平台公钥先进行base64解码
2.加密字符串转换成byte[], 按117位截取byte[]进行分段加密
3.使用RSA算法、ECB模式和PKCS1Padding填充方式来加密数据,如:RSA/ECB/PKCS1Padding
4.分段加密后的byte[]组合,在进行base64编码,完成最终bizModel加密
注:bizModel参数传空字符不进行RSA加密,接口会基于校验规则校验接口参数
请求示例:
image.png

响应参数#

参数字段参数说明数据类型
code返回码,成功返回200,其它根据接口会返回不同的错误编码integer
messagemessagestring
....返回数据,具体查看接口响应说明object
响应示例:
image.png
上一页
流程说明
下一页
通知说明
Built with