渠道接口
  1. module
渠道接口
  • module
    • 渠道数据回传接口文档
  1. module

渠道数据回传接口文档

概述#

本文档描述了渠道向系统回传数据的接口规范。所有接口采用 RESTful API 风格，JSON 格式数据传输。
Base URL: https://api.example.com/api/v1
公共响应格式:
{
  "code": 0,
  "message": "success",
  "data": {}
}
错误码说明:
错误码说明
0成功
1001参数错误
1002认证失败
1003Token 过期或无效
1004权限不足
5001服务器内部错误
全局 Header:
参数类型必填说明
Authorizationstring是Bearer Token (格式: Bearer {token})

一、认证接口#

1.1 获取 Access Token#

渠道使用分配的 appkey 和 secret 获取访问令牌。
请求地址: POST /auth/token
请求参数:
参数类型必填说明
appkeystring是渠道唯一标识
secretstring是渠道密钥
grant_typestring是固定值: client_credentials
请求示例:
{
  "appkey": "channel_001",
  "secret": "your_secret_key",
  "grant_type": "client_credentials"
}
响应示例:
{
  "code": 0,
  "message": "success",
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 7200,
    "refresh_token": "refresh_token_string"
  }
}

1.2 刷新 Token#

当 access_token 过期时，使用 refresh_token 获取新的访问令牌。
请求地址: POST /auth/refresh
请求参数:
参数类型必填说明
refresh_tokenstring是刷新令牌
grant_typestring是固定值: refresh_token

二、用户信息接口#

2.1 提交用户信息#

渠道向系统回传用户详细信息。
请求地址: POST /users
请求参数:
参数类型必填说明
namestring是用户姓名
id_cardstring是身份证号码
phonestring是手机号码
channel_user_idstring是渠道用户唯一标识
live_certificationobject否活体认证记录
活体认证记录 (live_certification):
参数类型必填说明
certifiedboolean是是否通过活体认证
certification_timestring是认证时间 (ISO 8601 格式)
certification_methodstring否认证方式 (如: face++, 支付宝活体)
face_scorefloat否人脸比对分数
liveness_scorefloat否活体检测分数
photosarray否活体认证照片URL列表
请求示例:
{
  "channel_user_id": "U20240101001",
  "name": "张三",
  "id_card": "110101199001011234",
  "phone": "13800138000",
  "live_certification": {
    "certified": true,
    "certification_time": "2024-01-15T10:30:00Z",
    "certification_method": "支付宝活体",
    "face_score": 95.5,
    "liveness_score": 98.2,
    "photos": [
      "https://cdn.example.com/face/photo1.jpg"
    ]
  }
}
响应示例:
{
  "code": 0,
  "message": "success",
  "data": {
    "user_id": "10001",
    "channel_user_id": "U20240101001",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

2.2 更新用户信息#

请求地址: PUT /users/:channel_user_id

2.3 获取用户信息#

请求地址: GET /users/:channel_user_id

三、企业信息接口#

3.1 提交企业信息#

渠道向系统回传企业详细信息。
请求地址: POST /companies
请求参数:
参数类型必填说明
channel_company_idstring是渠道企业唯一标识
company_namestring是企业名称
social_credit_codestring是统一社会信用代码
legal_personstring否法定代表人
contact_personstring否联系人
contact_phonestring否联系电话
business_licenseobject否营业执照信息
registered_addressstring否注册地址
business_scopestring否经营范围
营业执照信息 (business_license):
参数类型必填说明
license_numberstring是营业执照编号
license_photostring否营业执照照片URL
issue_datestring否发证日期
expiry_datestring否有效期至
registration_capitalfloat否注册资本
paid_in_capitalfloat否实缴资本
请求示例:
{
  "channel_company_id": "C20240101001",
  "company_name": "某某科技有限公司",
  "social_credit_code": "91110000MA00ABCD01",
  "legal_person": "李四",
  "contact_person": "王五",
  "contact_phone": "010-12345678",
  "registered_address": "北京市朝阳区某某街道",
  "business_scope": "技术开发、技术服务",
  "business_license": {
    "license_number": "91110000MA00ABCD01",
    "license_photo": "https://cdn.example.com/license.jpg",
    "issue_date": "2020-01-01",
    "expiry_date": "2050-12-31",
    "registration_capital": 1000000,
    "paid_in_capital": 500000
  }
}
响应示例:
{
  "code": 0,
  "message": "success",
  "data": {
    "company_id": "20001",
    "channel_company_id": "C20240101001",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

3.2 更新企业信息#

请求地址: PUT /companies/:channel_company_id

3.3 获取企业信息#

请求地址: GET /companies/:channel_company_id

四、任务信息接口#

4.1 提交任务信息#

渠道向系统回传企业创建的任务信息。
请求地址: POST /tasks
请求参数:
参数类型必填说明
channel_task_idstring是渠道任务唯一标识
channel_company_idstring是关联企业标识
task_namestring是任务名称
task_typestring是任务类型 (如: 短期工、长期工、兼职)
recruit_countinteger是招募人数
recruitment_start_timestring是招募开始时间
recruitment_end_timestring是招募结束时间
work_start_timestring否工作开始时间
work_end_timestring否工作结束时间
wage_descriptionstring否劳务费用发放说明
recruitment_descriptionstring否招募说明
work_locationstring否工作地点
job_requirementsstring否岗位要求
salaryobject否薪资信息
statusstring否任务状态 (open/closed/suspended)
薪资信息 (salary):
参数类型必填说明
salary_typestring是薪资类型 (hourly/月薪/日薪/按件)
amountfloat是薪资金额
currencystring否货币类型 (默认: CNY)
settlement_typestring否结清类型 (日结/周结/月结/完工结)
请求示例:
{
  "channel_task_id": "T20240101001",
  "channel_company_id": "C20240101001",
  "task_name": "春节临时工招聘",
  "task_type": "短期工",
  "recruit_count": 100,
  "recruitment_start_time": "2024-01-20T00:00:00Z",
  "recruitment_end_time": "2024-02-10T23:59:59Z",
  "work_start_time": "2024-02-01T08:00:00Z",
  "work_end_time": "2024-02-15T18:00:00Z",
  "work_location": "北京市朝阳区某某工厂",
  "job_requirements": "身体健康，能吃苦耐劳",
  "wage_description": "按月结算，次月15日发放工资",
  "recruitment_description": "招聘春节期间临时工，负责流水线作业",
  "salary": {
    "salary_type": "月薪",
    "amount": 5000,
    "currency": "CNY",
    "settlement_type": "月结"
  },
  "status": "open"
}
响应示例:
{
  "code": 0,
  "message": "success",
  "data": {
    "task_id": "30001",
    "channel_task_id": "T20240101001",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

4.2 更新任务信息#

请求地址: PUT /tasks/:channel_task_id

4.3 获取任务信息#

请求地址: GET /tasks/:channel_task_id

4.4 任务列表#

请求地址: GET /tasks
查询参数:
参数类型必填说明
channel_company_idstring否按企业筛选
statusstring否按状态筛选
pageinteger否页码 (默认: 1)
page_sizeinteger否每页数量 (默认: 20)

五、人员投递信息接口#

5.1 提交投递信息#

记录用户对某任务的投递信息。
请求地址: POST /applications
请求参数:
参数类型必填说明
channel_application_idstring是渠道投递唯一标识
channel_user_idstring是用户标识
channel_task_idstring是任务标识
applied_atstring是投递时间
resume_urlstring否简历URL
application_channelstring否投递渠道来源
statusstring否投递状态 (pending/accepted/rejected/cancelled)
remarkstring否备注
请求示例:
{
  "channel_application_id": "A20240101001",
  "channel_user_id": "U20240101001",
  "channel_task_id": "T20240101001",
  "applied_at": "2024-01-18T14:30:00Z",
  "resume_url": "https://cdn.example.com/resume.pdf",
  "application_channel": "渠道A",
  "status": "pending"
}
响应示例:
{
  "code": 0,
  "message": "success",
  "data": {
    "application_id": "40001",
    "channel_application_id": "A20240101001",
    "created_at": "2024-01-18T14:30:00Z"
  }
}

5.2 更新投递信息#

请求地址: PUT /applications/:channel_application_id

5.3 获取投递信息#

请求地址: GET /applications/:channel_application_id

5.4 投递列表#

请求地址: GET /applications
查询参数:
参数类型必填说明
channel_user_idstring否按用户筛选
channel_task_idstring否按任务筛选
statusstring否按状态筛选
start_datestring否开始日期
end_datestring否结束日期
pageinteger否页码
page_sizeinteger否每页数量

六、订单/付款信息接口#

6.1 提交付款记录#

记录对用户或投递记录的付款信息。
请求地址: POST /payments
请求参数:
参数类型必填说明
channel_payment_idstring是渠道付款唯一标识
payment_typestring是付款类型 (user/application)
channel_user_idstring否用户标识 (payment_type=user 时必填)
channel_application_idstring否投递记录标识 (payment_type=application 时必填)
amountfloat是付款金额
currencystring否货币类型 (默认: CNY)
payment_timestring是付款时间
payment_methodstring否付款方式 (银行转账/支付宝/微信/现金)
payment_channelstring否付款渠道
bank_namestring否银行名称
bank_accountstring否银行账号
transaction_nostring否交易流水号
payment_basisobject是付款依据
statusstring否付款状态 (pending/completed/failed)
remarkstring否备注
付款依据 (payment_basis):
参数类型必填说明
basis_typestring是依据类型 (工时/件数/月薪/日薪)
work_hoursfloat否工时数
work_date_startstring否工作开始日期
work_date_endstring否工作结束日期
descriptionstring否计算说明
supporting_docsarray否证明材料URL列表
请求示例:
{
  "channel_payment_id": "P20240101001",
  "payment_type": "application",
  "channel_application_id": "A20240101001",
  "channel_user_id": "U20240101001",
  "amount": 5000,
  "currency": "CNY",
  "payment_time": "2024-02-20T10:00:00Z",
  "payment_method": "银行转账",
  "payment_channel": "中国工商银行",
  "bank_name": "中国工商银行北京分行",
  "bank_account": "6222021234567890123",
  "transaction_no": "IOU20240220001",
  "payment_basis": {
    "basis_type": "月薪",
    "work_date_start": "2024-02-01",
    "work_date_end": "2024-02-15",
    "description": "2024年2月1日-15日工资",
    "supporting_docs": [
      "https://cdn.example.com/salary_sheet.pdf"
    ]
  },
  "status": "completed"
}
响应示例:
{
  "code": 0,
  "message": "success",
  "data": {
    "payment_id": "50001",
    "channel_payment_id": "P20240101001",
    "created_at": "2024-02-20T10:00:00Z"
  }
}

6.2 更新付款记录#

请求地址: PUT /payments/:channel_payment_id

6.3 获取付款记录#

请求地址: GET /payments/:channel_payment_id

6.4 付款记录列表#

请求地址: GET /payments
查询参数:
参数类型必填说明
channel_user_idstring否按用户筛选
channel_application_idstring否按投递记录筛选
payment_typestring否按付款类型筛选
statusstring否按状态筛选
start_datestring否开始日期
end_datestring否结束日期
pageinteger否页码
page_sizeinteger否每页数量

附录#

A. 数据类型说明#

类型说明
string字符串
integer整数
float浮点数
boolean布尔值 (true/false)
array数组
object对象
ISO 8601日期时间格式: YYYY-MM-DDTHH:MM:SSZ

B. 任务类型参考#

类型编码说明
short_term短期工
long_term长期工
part_time兼职
intern实习生

C. 薪资类型参考#

类型编码说明
hourly时薪
daily日薪
monthly月薪
piece计件

D. 结清类型参考#

类型编码说明
daily日结
weekly周结
monthly月结
completed完工结
修改于 2026-03-04 11:50:32
Built with