慧企星助 开放平台文档

慧企星助 开放平台面向企业三方系统提供标准 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": "技术贡献"
      }
    ]
  }
}
POST /api/openplatform/scoreApplications

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

参数类型必填说明
applicationTypeint申请类型,0=行为标准申请,1=自定义申请。
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/{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"
  }
}