すべてのドキュメントを閲覧

認証

Narwhal の REST と MCP リクエストには1つの Bearer キーを使用します。

Narwhal へのすべてのデータリクエストには API キーが必要です。Health、OpenAPI、ドキュメント UI は引き続き公開されています。

API キーを取得

GoogleまたはGitHubでアカウントを作成。サインイン後に無料キーが作成され、一度だけ表示されます。

次の内容: ダッシュボード サインイン中のアカウントと設定リンクを表示します。完全なキーは引き続き1回だけ表示されます。

キーを安全に保存

キーは発行時に1回だけ返されます。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 サポートを求める場合。キー自体は決して送信しないでください。

復旧とローテーション

サインインして開く: ダッシュボード 有効なキーを置き換えまたは失効させるため。置き換えまたは失効により旧キーは直ちに停止します。置換キーは1回だけ表示され、後で復元できません。

アカウントセッションへのアクセスを失った場合は、公開されたキーの使用を停止し、 Narwhal API に連絡 サポート向け。

次の内容で続行 クイックスタート キーを安全に保存した後。