REST API
APIキー
個人APIキーを使用して、スクリプトからREST APIを呼び出します。
キーの作成と取り消し
NinjaBuyにログインし、アカウント → 友達紹介 → APIキーを開くと、名前付きキーの作成、一覧表示、取り消しができます。完全なキーはnb_で始まり、一度だけ表示されます。メッセージを閉じる前にキーをコピーを使い、安全に保管してください。
キーは、作成時に有効期間（30日、90日、1年）を選ばない限り失効しません。取り消しや有効期間の終了は次のリクエストから適用され、期限切れのキーは一覧から消えます。
保存されるのはキーのSHA-256ハッシュのみです。
キーの使用
キーをスクリプトにNINJABUY_API_KEYとして渡し、Authorizationヘッダーで送信します。
curl -sS https://www.ninjabuy.com/api/v1/links \
-H "Authorization: Bearer $NINJABUY_API_KEY" \
-H "Content-Type: application/json" \
--data '{"links":["https://weidian.com/item.html?itemID=7581746714"]}'同じヘッダーを、認証が必要なすべてのRESTルートで使用できます。リンク、検索、アップロード、シート、ジョブが対象です。OpenAPIドキュメントに認証は不要です。
権限と制限
すべてのキーに3つの権限すべてが付与されます。スコープの選択機能はありません。
| 権限 | ルート |
|---|---|
links:create | POST /api/v1/links, POST /api/v1/uploads, POST /api/v1/sheets |
jobs:read | GET /api/v1/jobs/{id} |
search:read | GET /api/v1/search |
キーとOAuthのRESTリクエストは、アカウントの作成枠と検索枠を共有します。MCPでのリンク作成も作成枠を共有します。レート制限をご覧ください。
キーでは、ログイン、セッションの開始、MCPやアカウントAPIの呼び出しはできません。他のNinjaBuyユーザーに代わって動作するアプリケーションやMCPクライアントにはOAuthを使用してください。
エラー
無効、期限切れ、または取り消されたキーは、無効なOAuthトークンと同じ401の問題レスポンスを返します。キーのストレージに障害がある場合は、Retry-Afterとともに503を返します。エラーをご覧ください。