認証

ヘルスチェックを除くすべてのリクエストにAPIキーが必要です。このページではキーの取得方法、正確なヘッダー形式、サーバー側で使う際の推奨セキュリティ対策を説明します。

すべての業務用エンドポイントはヘッダーによるAPIキー認証を使用します。キーが未設定または無効な場合は、通常 401 または 403 が返ります。

必須ヘッダー

bash
Authorization: YOUR_API_KEY

Node.js の例

javascript
const res = await fetch("https://openapi.scdata.cc/api/v1/youtube/user/info?channel_id=UC_x5XG1OV2P6uZZ5FSM9Ttw", {
headers: {
Authorization: process.env.SCRUMBALL_API_KEY,
},
});
const data = await res.json();

セキュリティ上の注意

  • APIキーをクライアント側のコードや公開リポジトリに含めないでください。
  • dev / staging / production など環境ごとにキーを分けてください。
  • キーが漏洩した可能性がある場合は、ダッシュボードで失効させ、すぐに新しいキーを作成してください。