用途:帮助在项目中完成 Hex 的安装与认证配置,以便通过 Hex API 以编程方式触发项目运行、查询状态、管理用户和配置连接。
前置条件:Hex 账号(Team 或 Enterprise 方案)、用于生成 API 令牌的工作区管理员权限、至少一个已发布的 Hex 项目。
使用方式:先在 Hex 工作区设置中进入 API tokens,点击 New Token,设置描述与有效期,并选择作用域(Read projects 和/或 Run projects)。随后在环境变量中配置 HEX_API_TOKEN 与 HEX_WORKSPACE_URL(如 https://app.hex.tech),并确保 .env、.env.local 已加入 .gitignore,切勿提交令牌。可用 curl 或 TypeScript 脚本向 https://app.hex.tech/api/v1/projects 发送带 Authorization: Bearer 的请求来验证连接。
主要能力与作用域:Read projects 覆盖 ListProjects、GetProjectRuns、GetRunStatus,适合监控;Run projects 覆盖 RunProject、CancelRun 及全部读取权限,适合编排。
常见错误:401 表示令牌无效或过期,需重新生成;403 表示缺少作用域,应创建带 Run projects 的令牌;404 表示工作区 URL 错误,需核对 HEX_WORKSPACE_URL。
输出要求:返回认证设置凭据时使用环境、密钥引用而非密钥值、令牌作用域类别、已批准项目/目标结果、合成连通性和轮换/清理负责人,切勿打印访问令牌、SQL 或输出内容。
限制:资料未提供 SDK/CLI 的具体安装命令、价格与平台细节。