慧企星助 开放平台文档

慧企星助 开放平台面向企业三方系统提供标准 HTTP API,支持员工、绑定关系、项目、目标与目标复盘、任务、通知、便签、标签、贡献点和附件上传能力。 所有接口默认只作用于当前 API Key 所属企业,权限由后端统一控制并在请求时强校验。

显示全部接口

贡献申请接口

贡献申请接口用于三方系统提交贡献申请、查询申请列表、查询行为标准、获取申请详情等。所有接口都必须通过 X-Employee-Virtual-Id 指定当前操作人。

三方标识说明:通过开放平台创建的贡献申请,在查询详情时会返回 apiKeyIdapiKeyName 字段,用于标识该申请来源于哪个三方应用。
GET /api/openplatform/scoreApplications/metadata

获取贡献申请初始化参数,包括是否允许匿名申请、自定义申请的分值上下限等。

{
  "statusCode": 100,
  "msg": "获取成功",
  "data": {
    "allowAnonymous": true,
    "minScore": 1,
    "maxScore": 100
  }
}
GET /api/openplatform/scoreApplications/standards

获取行为标准列表(分页),支持按关键字搜索。

参数类型必填说明
pageint页码,默认 1。
pageSizeint每页条数,默认 20。
keywordstring行为标准名称关键字。
{
  "statusCode": 100,
  "msg": "获取成功",
  "data": {
    "total": 10,
    "items": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "优秀代码贡献",
        "description": "对项目有显著贡献的代码提交",
        "score": 10,
        "category": "技术贡献"
      }
    ]
  }
}

列表响应字段

字段类型说明
data.totallong符合关键字筛选条件的行为标准总数。
data.pageint当前页码,从 1 开始。
data.pageSizeint当前页返回条数上限,范围为 1 到 100。
data.itemsStandardItem[]当前页行为标准数据。
idguid行为标准标识,用于提交申请时的 standardItemId
namestring行为标准名称。
descriptionstring行为标准说明。
scoredecimal标准贡献点,单位为“点”。
categorystring行为标准所属分类。
POST /api/openplatform/scoreApplications

提交贡献申请,支持自定义申请和行为标准申请两种类型。

参数类型必填说明
applicationTypestring申请类型(字符串枚举):standard 按行为标准申请、custom 自定义分值申请。
targetEmployeeVirtualIdsstring[]目标员工 virtualId 列表。
amountdecimal申请贡献点(自定义申请时必填)。
reasonstring申请理由。
attachmentUrlsstring[]附件 URL 列表。
isAnonymousbool是否匿名申请。
standardItemsobject[]行为标准申请项列表(行为标准申请时必填)。
standardItems 项结构
参数类型必填说明
standardItemIdstring行为标准项 ID (UUID)。
amountdecimal申请贡献点。
reasonstring申请理由。
attachmentUrlsstring[]附件 URL 列表。
{
  "statusCode": 100,
  "msg": "申请已提交",
  "data": {
    "id": "b34b6f3f-f84e-45ce-8c44-bb85d55a9ef5",
    "message": "申请已提交"
  }
}
GET /api/openplatform/scoreApplications

分页查询贡献申请列表,一个接口覆盖待操作、进行中、历史三档(参考任务列表 view 分组模式)。view=pendingActions 待我处理(待我审批/确认/处理驳回申诉/处理投诉)、view=inProgress 进行中(与我相关且未完结)均与当前操作人身份绑定,仅支持 keyword 筛选;view=history 历史归档(已归档申请)按操作人的贡献可见权限判定范围,额外支持来源人、被申请人、申请类型与申请时间筛选。已执行的贡献流水明细请用贡献点接口的 scoreChanges(与历史申请同一查询口径)。

查询参数:

  • view:列表分组,必填:pendingActions 待我处理、inProgress 进行中、history 历史归档
  • keyword:标题/行为关键字模糊筛选,三档通用,可选
  • applicationType:申请类型筛选(仅 view=history 支持),可选:standard 行为标准、custom 自定义分值
  • applicantVirtualId:来源人(申请人)virtualId 筛选(仅 view=history 支持),可选
  • targetEmployeeVirtualId:被申请(受益)员工 virtualId 筛选(仅 view=history 支持),可选
  • startAt / endAt:申请时间范围起止(含),ISO 8601 格式(仅 view=history 支持),可选
  • page:页码,从 1 开始,默认 1
  • pageSize:每页条数,1-100,默认 20

响应行字段说明:creator 为来源人(申请人)成员对象(virtualId/name/phone,手机号脱敏);匿名申请(isAnonymoustrue)时除申请人本人外 creator 返回 nullapplicationType 对外口径为 standard/custom/systemstatus/statusName 为申请状态数值与中文名(待审批/待确认/已执行/归档/被驳回/申诉中)。

{
  "statusCode": 100,
  "msg": "获取成功",
  "data": {
    "total": 2,
    "page": 1,
    "pageSize": 20,
    "items": [
      {
        "id": "4a5b6c7d-8e9f-4a1b-8c9d-0e1f2a3b4c5d",
        "status": 0,
        "statusName": "待审批",
        "applicationType": "standard",
        "score": 10,
        "title": "季度优秀协作",
        "reason": "跨部门项目支撑",
        "isAnonymous": false,
        "employeeVirtualId": "emp_T7dQ2mYk8rLp4cN1sVx3bH9wAe6fJuKz",
        "employeeName": "张三",
        "creator": {
          "virtualId": "emp_R8sP3nWq6tMv2xK9yB4cD7eF0gH1jLkA",
          "name": "李四",
          "phone": "138****5678"
        },
        "appliedAt": "2026-06-01T10:00:00",
        "confirmedAt": null,
        "apiKeyName": null
      },
      {
        "id": "9d0e1f2a-3b4c-4d5e-8f9a-1b2c3d4e5f6a",
        "status": 3,
        "statusName": "归档",
        "applicationType": "custom",
        "score": -2,
        "title": "匿名调整",
        "reason": "匿名贡献",
        "isAnonymous": true,
        "employeeVirtualId": "emp_T7dQ2mYk8rLp4cN1sVx3bH9wAe6fJuKz",
        "employeeName": "张三",
        "creator": null,
        "appliedAt": "2026-06-02T10:00:00",
        "confirmedAt": "2026-06-03T10:00:00",
        "apiKeyName": null
      }
    ]
  }
}
GET /api/openplatform/scoreApplications/{id}

获取贡献申请详情。

{
  "statusCode": 100,
  "msg": "获取成功",
  "data": {
    "id": "b34b6f3f-f84e-45ce-8c44-bb85d55a9ef5",
    "status": 1,
    "applicationType": 1,
    "apiKeyId": "c56d7f8g-h90i-1234-jklm-no5678901234",
    "apiKeyName": "我的三方应用",
    "score": 10,
    "reason": "优秀代码贡献",
    "attachmentUrls": [],
    "isAnonymous": false,
    "createdAt": "2026-06-18T10:00:00+08:00"
  }
}

详情响应字段

字段类型说明
idguid贡献申请标识。
statusint贡献申请当前状态码。
applicationTypeint申请类型:0 行为标准申请,1 自定义申请。
apiKeyIdguid创建申请的 API Key 标识;非开放平台创建的申请为 Guid.Empty
apiKeyNamestring创建申请的三方应用名称;非开放平台创建的申请为空字符串。
scoredecimal申请贡献点,单位为“点”。
reasonstring申请理由。
attachmentUrlsstring[]申请附件的公开访问 URL 列表。
isAnonymousbool是否匿名申请。
createdAtstring申请创建时间,ISO 8601 带时区字符串。