慧企星助 开放平台文档

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

显示全部接口

错误码与排查

HTTP 状态statusCode说明
400400 / 101请求参数错误,例如标题为空、附件为空、virtualId 无效等。
40140101缺少认证请求头。
40140102API Key 无效。
40140103时间戳格式错误。
40140104请求已过期。
40140105签名校验失败。
40140106Nonce 重复,或请求被重复使用。
40340301API Key 已停用。
40340302API Key 已过期。
40340303IP 不在白名单中。
40340304操作人不属于当前企业,或当前员工上下文无效。
403403权限不足,或缺少 X-Employee-Virtual-Id,或当前 API Key 未授权指定能力。
404404员工、任务、绑定关系等资源不存在。
502502 及其他大于 100 的状态码开放平台网关调用下游内部服务失败,或下游返回结构异常。
500500系统异常。
状态码约定:HTTP 状态码 用于表示错误大类(如 401 认证失败、403 授权失败),statusCode 用于表示更细粒度、可供程序稳定判断的机器错误码;两者不要求一一对应。
日志说明:开放平台请求日志会记录请求体和响应体,日志中的手机号、姓名、各种业务 Id、virtualId、第三方用户标识等敏感字段都会做脱敏处理。GET 请求会把查询串按 [query]?... 形式写入 RequestBody,并按字段名统一脱敏。

常见排查项

  • 确认 API Key 已启用、未过期,且命中白名单。
  • 确认签名原文中的路径、QueryString、Body 与真实请求完全一致。
  • 确认每次请求都重新生成 X-TimestampX-NonceX-Signature,不要在重试或并发请求中复用旧请求头。
  • 确认需要当前员工身份的接口都传了 X-Employee-Virtual-Id
  • 确认被引用的员工 virtualId 来自当前 API Key 下的 /employees 返回结果。