クイックスタート

ShortsMonkey アカウントと、HTTPS アクセスを持つサーバー側端末を準備します。 cURL の例には cURL が必要です。 JavaScript にはフェッチ機能を備えた Node.js が必要です。 Python にはリクエストが必要です。表示されているすべてのキーはプレースホルダーです。自分のアカウントのキーを使用してください。

サインインして、API コンソールを開き、1 回限りの公開から完全なキーをコピーします。 REST リクエストには api:read; が必要です。 MCP ツールには mcp:read が必要です。両方の統合に対して両方を選択するか、統合に必要な権限のみを選択します。

export SHORTSMONKEY_API_KEY="sm_live_..."

GET /v1/auth/verify、GET /v1/credits、GET /v1/credits/costs、ヘルスチェック、キー管理は 1 日 10 回のデータ呼び出し枠を消費しません。認証と所有者の確認は維持されます。

ターミナルで curl -i https://api.shortsmonkey.com/v1/auth/verify -H "Authorization: Bearer $SHORTSMONKEY_API_KEY" を実行します。この REST チェックには api:read も必要です。 HTTP 200 を予期し、data.authenticated が true であり、data.scopes に api:read が含まれていることを確認します。認証が成功しても、ランキングが空でないことは保証されません。

以下の例のいずれかを実行します。 3 つすべてを実行する必要はありません。このリクエストは、保存されている安定した中国語の長いビデオ スナップショットを読み取り、ライブ YouTube フェッチをトリガーしません。まず HTTP ステータスを確認してください。 200 以外の応答の場合は、エラー JSON をランキング データとして扱う代わりに、error.code を読み取ります。

data.all_data.items には、リクエスト フィルターの前の現在のページが含まれます。 data.filter_data.items には、デフォルトとリクエスト フィルター後の現在のページが含まれます。どちらの配列も空である場合があり、その数が異なる場合があります。空の配列は認証の失敗ではありません。 meta.snapshot_at を使用してデータの古さを評価し、診断用に meta.request_id を保持します。

別のページでは、元のフィルターを保持したまま、all_data.next_cursor を all_cursor として渡し、filter_data.next_cursor を filter_cursor として渡します。 null で結果セットが終了します。 cursor を交換しないでください。新しい REST データ リクエストが成功するたびに、毎日の呼び出しが使用されます。 Credits.unlimited が true であっても、無制限のデータ要求を意味するわけではありません。 daily_usage.remaining を確認してください。

401 INVALID_API_KEY: 完全な sm_live_ キー、Bearer の後のスペース、環境変数、およびキーの有効期限が切れているか、取り消されているか、またはローテーション猶予期間を過ぎているかどうかを確認してください。 403 INSUFFICIENT_SCOPE については、api:read; を確認してください。 403 ACCOUNT_DISABLED の場合は、アカウントのステータスを確認し、サポートにお問い合わせください。再試行を繰り返しても、認証や権限は修復されません。

429 を error.code で区別します: API_DAILY_LIMIT_REACHED はアジア/上海 00:00 まで待つ必要があります。 RATE_LIMITED では、頻度と同時リクエストを減らし、指定された場合は Retry-After を尊重する必要があります。 503 DATA_STALE は、保存されたスナップショットが古すぎることを意味します。 SERVICE_UNAVAILABLE は、一時的に利用できないことを意味します。バックオフを伴う制限付き再試行を使用し、リクエスト ID を保持します。

キーをサーバー側の環境変数またはシークレット ストアに保持し、Authorization ヘッダーで送信します。ブラウザー コード、URL、Git、スクリーンショット、ログ、または分析には配置しないでください。診断用のリクエスト ID、操作、時間、ステータス、およびエラー コードのみを共有します。公開された場合は、コンソールでキーをローテーションまたは取り消し、サーバー構成を更新します。