瀏覽全部文件

身份驗證

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 尋求幫助時;絕不要發送密鑰本身。

恢復與輪換

登錄並打開 儀表板 用於替換或撤銷活動密鑰。替換或撤銷會立即停止舊密鑰;替換密鑰只顯示一次,之後無法恢復。

如果你失去了對帳戶會話的存取權限,請停止使用任何已暴露的密鑰,並 聯繫 Narwhal API 以獲取幫助。

繼續使用該 快速入門 在密鑰安全儲存之後。