API 密钥 #

API 密钥让脚本和机器人能以你的账户身份访问 Meldry 服务器。

创建密钥 #

  1. 打开 设置 → API Keys
  2. 点击 创建 API Key
  3. 起一个有意义的名字(例如 ci-deploy-bot)。
  4. 立即复制——Meldry 只显示一次。

为防滥用,每小时最多创建 5 个密钥。

使用密钥 #

将密钥作为 Bearer token 放到 Authorization 头:

bash
curl -H "Authorization: Bearer <your-api-key>" \
  https://your-server.meldry.com/api/me

大部分租户 API 同时接受 API 密钥与会话 token。

撤销密钥 #

设置 → API Keys 中点击对应密钥旁的删除图标即可。撤销立即生效,后续使用该密钥的请求会返回 401。

最佳实践 #

  • 按集成命名密钥,而不是按机器命名,便于审计与轮换。
  • 当某个集成下线或人员变动时,及时轮换密钥
  • 不要把密钥提交到 git——使用环境变量或秘密管理器。
  • 开发、预发、生产使用 不同的密钥,泄露时影响范围更小。