慧企星助 开放平台文档

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

显示全部接口

权限说明

当前 API Key 的权限配置只接受字符串数组 JSON,例如 ["employees.read","tasks.write","notes.read"]。对象结构或空权限都不会被放行。

bindings.read bindings.write employees.read labels.read projects.read projects.write tasks.read tasks.write objectives.read objectives.write objectiveReviews.read objectiveReviews.write notices.write notes.read notes.write scores.read scores.write scoreApplies.read scoreApplies.write attachments.write
权限值 名称 说明
bindings.read 读取绑定关系 允许查询当前 API Key 下的第三方账号绑定列表和绑定详情。
bindings.write 管理绑定关系 允许创建、更新和解绑当前 API Key 下的第三方账号绑定关系。
employees.read 读取员工 允许查询当前企业员工列表和员工详情。
labels.read 读取标签 允许按当前访问员工身份查询当前企业可见标签。
projects.read 读取项目 允许查询当前访问员工可见的项目、项目分组和项目进度。
projects.write 管理项目 允许创建、修改和删除当前访问员工有权限操作的项目。
tasks.read 读取任务 允许查询当前企业任务列表和任务详情。
tasks.write 创建任务 允许在当前企业创建任务。
objectives.read 读取目标 允许查询当前访问员工可见的目标、关键结果和目标周期。
objectives.write 管理目标 允许创建、修改和删除当前访问员工有权限操作的目标及其关键结果。
objectiveReviews.read 读取目标复盘 允许查询当前访问员工可见目标的复盘记录。
objectiveReviews.write 管理目标复盘 允许提交和修改当前访问员工有权限操作目标的复盘记录。
notices.write 发送通知 允许向当前企业指定员工发送通知。
notes.read 读取便签 允许查询当前员工可见的便签、便签包和操作记录。
notes.write 管理便签 允许新增、修改、共享、移动和删除当前员工有权限操作的便签及便签包。
scores.read 读取贡献点 允许查询员工当前贡献点信息。
scores.write 变更贡献点 允许提交贡献点增加或扣减请求。
scoreApplies.read 读取贡献申请 允许查询贡献申请列表和详情。
scoreApplies.write 提交贡献申请 允许提交贡献申请。
attachments.write 上传附件 允许上传任务附件。
权限与模块对应关系:
  • employees.read:查询员工公开信息和员工 virtualId
  • bindings.readbindings.write:查询或维护第三方账号绑定关系。
  • projects.readprojects.write:查询或管理当前员工可见且有权限操作的项目。
  • objectives.readobjectives.write:查询或管理当前员工可见且有权限操作的目标和关键结果。
  • objectiveReviews.readobjectiveReviews.write:查询、提交或修改当前员工有权限操作目标的复盘。
  • tasks.readtasks.write:查询任务、任务初始化数据和任务操作。
  • notices.write:通过开放平台发送通知。
  • notes.readnotes.write:查询或操作便签、便签包和便签夹。
  • labels.readlabels.write:查询或维护标签。
  • scores.readscores.write:查询或维护贡献点记录。
  • scoreApplications.readscoreApplications.write:查询或提交贡献点申请。
  • attachments.write:上传开放平台附件。
权限校验说明:权限只决定 API Key 是否具备访问能力,不能替代业务身份和资源权限。需要当前员工身份的接口仍必须传 X-Employee-Virtual-Id;任务、便签和通知的具体操作还会继续校验当前员工是否有对应业务权限。