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

認証

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回だけ表示します。新しいキーを導入できるように旧キーは24時間有効で、その前に停止することもできます。失効操作ではすべてのキーが直ちに無効になります。 24時間の猶予期間はRESTとMCPのみが対象で、イベントストリームとブラウザー用ストリームチケットには現在有効なキーが必要です。旧キーのストリームは約15秒以内に切断され、旧キーでの新規接続は拒否されるため、新しいキーでストリームに再接続してください。

アカウントのセッションにアクセスできなくなった場合は、漏えいしたキーの使用を停止し、 Narwhal API に連絡 サポート向け。

続けて、 クイックスタート は、キーを安全に保存してから進めてください。