身份验证

Narwhal的REST和MCP请求使用同一个Bearer密钥。

每个 Narwhal 数据请求都需要 API 密钥。健康检查、OpenAPI 和文档界面仍可公开访问。

获取 API 密钥

使用 Google 或 GitHub 创建账户。登录后会创建一个免费密钥，且仅显示一次。

该仪表板显示你的已登录账户和设置链接。完整密钥仍只显示一次。

安全存储密钥

密钥签发时只返回一次。Narwhal 只存储单向验证值，而不存储密钥本身，因此同一密钥不能再次显示。

将其保存在密钥管理器或本地环境变量中。
不要将其提交到代码仓库、粘贴到日志中或放入 URL。
不要在浏览器端代码中暴露它。

终端

export NARWHAL_API_KEY="nw_live_..."

对请求进行身份验证

将密钥放入 HTTP Authorization 请求头，使用 Bearer 认证方式发送。REST 和 MCP 使用相同的请求头。

已认证的 REST 请求

curl --request GET \
  --url https://api.narwhalapi.com/v1/economics/USA/cpi \
  --header "Authorization: Bearer $NARWHAL_API_KEY"

处理被拒绝的密钥

缺失、格式错误、非活动或未知的密钥会返回 401 使用代码 invalid_api_key 以及 WWW-Authenticate: Bearer 标头。

被拒绝的身份验证不会消耗月度配额。请使用响应中的 request_id 寻求帮助；切勿发送密钥本身。

恢复与轮换

登录并打开仪表板用于轮换或撤销密钥。轮换会显示一次新密钥，并让旧密钥继续有效 24 小时，以便你部署新密钥；你也可以提前停用旧密钥。撤销会立即停止所有密钥。 24 小时宽限期仅适用于 REST 和 MCP；事件流和浏览器流票据必须使用当前有效的密钥。使用旧密钥的流会在约 15 秒内关闭，使用旧密钥的新连接会被拒绝；请使用新密钥重新连接流。

如果你失去了对账户会话的访问权限，请停止使用任何已暴露的密钥，并联系 Narwhal API 以获取帮助。

继续参阅快速入门（请先安全存储密钥）。