慧企星助 开放平台文档

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

显示全部接口

权限说明

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

bindings.read bindings.write employees.read departments.read labels.read labels.write projects.read projects.write tasks.read tasks.write automationTasks.read automationTasks.write rewardTasks.read rewardTasks.write projectTasks.read projectTasks.write objectives.read objectives.write objectiveReviews.read objectiveReviews.write notices.write notes.read notes.write scores.read scoreApplies.read scoreApplies.write scoreQrCodes.read scoreQrCodes.write attachments.read attachments.write welfare.read welfare.write reports.read reports.write achievements.read achievements.write medals.read medals.write disk.read disk.write
权限值 名称 说明
bindings.read 读取绑定关系 允许查询当前 API Key 下的第三方账号绑定列表和绑定详情。
bindings.write 管理绑定关系 允许创建、更新和解绑当前 API Key 下的第三方账号绑定关系。
employees.read 读取员工 允许查询当前企业员工列表和员工详情。
departments.read 读取部门 允许查询当前企业部门树与部门信息(不含成员明细)。
labels.read 读取标签 允许按当前访问员工身份查询当前企业可见标签。
labels.write 管理标签 允许新增、修改和删除当前企业标签字典。
projects.read 读取项目 允许查询当前访问员工可见的项目、项目分组和项目进度。
projects.write 管理项目 允许创建、修改和删除当前访问员工有权限操作的项目。
tasks.read 读取任务 允许查询当前企业任务列表和任务详情。
tasks.write 管理任务 允许创建、修改任务并执行完成、审核、催办等任务操作。
automationTasks.read 读取自动化任务 允许查询当前员工有权限查看的自动化任务。
automationTasks.write 管理自动化任务 允许创建、修改、启停、重发和删除自动化任务。
rewardTasks.read 读取悬赏任务 允许查询本人创建或当前可领取的悬赏任务。
rewardTasks.write 管理悬赏任务 允许创建、修改、领取、撤销和标记悬赏任务。
projectTasks.read 读取项目任务 允许查询当前访问员工有权限查看的项目下任务与操作记录。
projectTasks.write 管理项目任务 允许创建、修改、审批、发送和删除当前访问员工有权限操作的项目任务。
objectives.read 读取目标 允许查询当前访问员工可见的目标、关键结果和目标周期。
objectives.write 管理目标 允许创建、修改和删除当前访问员工有权限操作的目标及其关键结果。
objectiveReviews.read 读取目标复盘 允许查询当前访问员工可见目标的复盘记录。
objectiveReviews.write 管理目标复盘 允许提交和修改当前访问员工有权限操作目标的复盘记录。
notices.write 发送通知 允许向当前企业指定员工发送通知。
notes.read 读取便签 允许查询当前员工可见的便签、便签包和操作记录。
notes.write 管理便签 允许新增、修改、共享、移动和删除当前员工有权限操作的便签及便签包。
scores.read 读取贡献点 允许查询员工当前贡献点信息。
scoreApplies.read 读取贡献申请 允许查询贡献申请列表和详情。
scoreApplies.write 提交贡献申请 允许提交贡献申请。
scoreQrCodes.read 读取贡献二维码 允许查询当前企业行为标准贡献二维码列表和详情。
scoreQrCodes.write 管理贡献二维码 允许新增、修改、删除和审核当前企业行为标准贡献二维码。
attachments.read 读取附件 允许获取当前访问员工可见附件的短时效下载地址。
attachments.write 上传附件 允许上传任务附件。
welfare.read 读取福利 允许查询当前企业福利商品、分类、申请记录和金币数据。
welfare.write 管理福利 允许申请福利、审核福利申请、评论福利商品和维护福利设置。
reports.read 读取工作汇报 允许查询当前访问员工收到、发送和历史的汇报及统计数据。
reports.write 管理工作汇报 允许发送、确认、申诉、撤回工作汇报,提交考核评分和维护汇报模板。
achievements.read 读取成就 允许查询当前访问员工的成就类别、待领取列表和成就详情。
achievements.write 管理成就 允许领取当前访问员工已达成的成就奖章。
medals.read 读取奖章 允许查询当前访问员工可见的奖章类别、奖章列表、排行和颁发权限。
medals.write 管理奖章 允许颁发奖章、领取奖章和设置奖章排行。
disk.read 读取网盘 允许查询当前企业网盘容量、文件夹、文件列表、详情和操作记录。
disk.write 管理网盘 允许新建、编辑、移动、删除和共享当前访问员工有权限操作的网盘文件与文件夹。
权限与模块对应关系:
  • employees.read:查询员工公开信息和员工 virtualId
  • bindings.readbindings.write:查询或维护第三方账号绑定关系。
  • projects.readprojects.write:查询或管理当前员工可见且有权限操作的项目。
  • objectives.readobjectives.write:查询或管理当前员工可见且有权限操作的目标和关键结果。
  • objectiveReviews.readobjectiveReviews.write:查询、提交或修改当前员工有权限操作目标的复盘。
  • tasks.readtasks.write:查询任务、任务初始化数据;创建、修改任务并执行任务操作(完成、审核、催办等)。
  • automationTasks.readautomationTasks.write:查询或管理自动化任务,包括创建、修改、启停、重发、执行、审批和附件操作。
  • rewardTasks.readrewardTasks.write:查询或管理悬赏任务,包括创建、修改、领取、撤销、标记已读和附件操作。
  • projectTasks.readprojectTasks.write:查询或管理项目下尚未发送的任务,包括创建、修改、审批、发送、删除和附件操作。
  • notices.write:通过开放平台发送通知。
  • notes.readnotes.write:查询或操作便签、便签包和便签夹。
  • labels.readlabels.write:查询或维护标签。
  • scores.read:查询贡献统计(摘要、看板、趋势、排行榜)。
  • scoreQrCodes.read:查询行为标准贡献二维码列表和详情。
  • scoreQrCodes.write:维护行为标准贡献二维码(新增、修改、删除、启用停用、审核)。
  • scoreApplies.readscoreApplies.write:查询或提交贡献点申请。
  • attachments.read:获取开放平台附件的短时效下载地址。
  • attachments.write:上传开放平台附件。
  • welfare.readwelfare.write:查询福利数据或申请、审核福利与评论商品。
  • reports.readreports.write:查询工作汇报或发送、确认、申诉、撤回汇报与维护模板。
  • achievements.readachievements.write:查询成就或领取成就奖章。
  • medals.readmedals.write:查询奖章或颁发、领取奖章与设置排行。
  • disk.readdisk.write:查询网盘数据或新建、编辑、删除、共享网盘文件。
权限校验说明:权限只决定 API Key 是否具备访问能力,不能替代业务身份和资源权限。需要当前员工身份的接口仍必须传 X-Employee-Virtual-Id;任务、便签和通知的具体操作还会继续校验当前员工是否有对应业务权限。
个人 MCP 调用额度:个人 MCP(/mcp)每次工具调用均消耗双维度每日额度——企业额度与成员额度(成员为 API Key 所有者),任一耗尽即拒绝本次调用。额度取值优先级:企业后台配额覆盖值 > 所属套餐默认值;额度耗尽与暂停时 MCP 返回 structuredContent.callResultStatus = 5(RateLimited),文本提示区分"企业今日 MCP 调用额度已用完"、"成员今日 MCP 调用额度已用完"与"调用已暂停"三种原因;每日额度按天重置。开放平台 REST 接口(/api/openplatform)不消耗 MCP 调用额度。