Ubuntu 中 Postman 使用 API 密钥的实用指南
一 在请求中携带 API Key
- 在 Postman 中新建或打开请求,切换到 Headers 选项卡。
- 按服务端要求添加键值对,常见写法如下(以服务端要求为准):
- 头部方式:键为 X-API-Key,值为你的密钥(示例:abc123xyz)。
- 头部方式(自定义头):键为 apikey 或 Authorization,值直接填密钥或按约定前缀拼接。
- 查询参数方式:在 Params 中添加键(如 api_key 或 key),值为你的密钥。
- 发送请求验证返回状态码与响应内容。若返回 401/403,通常是密钥错误、位置不对或权限不足。以上做法属于 API Key 鉴权的通用用法,适用于在 Postman 中测试需要 API Key 的接口。
二 使用 Postman 账号的 API Key 登录 CLI(Newman 或 CI)
- 在 Ubuntu 终端安装 Postman CLI(Newman 的增强版):
- 运行:
curl -o- "https://dl-cli.pstmn.io/install/linux64.sh" | sh
- 使用你的 Postman 账号 API Key 登录(注意这是 Postman 平台的账号密钥,不是你被测服务的密钥):
- 运行:
postman login --with-api-key <你的Postman账号API Key>
- 之后可在 CI(如 GitHub Actions)中安全使用该密钥:
- 在仓库 Settings > Secrets and variables > Actions 创建名为 POSTMAN_API_KEY 的 secret。
- 工作流示例:
- 安装 CLI:
curl -o- "https://dl-cli.pstmn.io/install/linux64.sh" | sh
- 登录:
postman login --with-api-key ${{ secrets.POSTMAN_API_KEY }}
- 运行集合:
postman collection run <collection_id> --environment <env_id>
这种方式适合在 Ubuntu 服务器或 CI 环境中以 Postman CLI 执行集合与生成报告。
三 在 Postman 桌面客户端保存被测服务的 API Key(可选)
- 打开 Postman,点击左上角头像进入 Settings > General,在 API Key 部分可生成或粘贴你的 Postman 账号 API Key,便于与 Postman 云服务协同(如同步、团队功能等)。
- 对于被测服务的密钥,更推荐放入 环境变量 管理:
- 点击右上角 Manage Environments 创建环境(如 Development)。
- 新增变量(如 API_KEY),值为你的服务密钥;在请求头或参数中用 {{API_KEY}} 引用。
- 选择对应环境后发送请求,便于在不同环境间切换密钥。
四 常见问题与排查
- 返回 401 Unauthorized / 403 Forbidden:核对密钥是否正确、放在了服务端要求的 Header/Query 位置、是否有权限访问该资源。
- 使用 Mock Server 的私有服务:创建时为私有 Mock 生成 x-api-key,并在请求头中添加 x-api-key: <你的密钥>。
- 安全性建议:始终使用 HTTPS 传输密钥;密钥不要硬编码在脚本或代码仓库中,优先使用 环境变量/Secret 管理;遵循最小权限原则与必要的日志审计。