身分驗證

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 以取得幫助。

接著使用快速入門指南繼續操作，但請先安全儲存金鑰。