認証・ウォッチリスト・その他
Trading API — 認証・ウォッチリスト・その他(Auth, WatchList & Other)
認証・ウォッチリスト・その他カテゴリには、トークン管理、ウォッチリスト操作、知的財産権保護(VeRO)に関する 9 つのコールが含まれます。アプリケーションの認証基盤やユーザー体験の補完機能を提供します。
よくある利用シナリオ
- Auth'n'Auth 認証フロー:
GetSessionIDでセッション ID を取得 → ユーザーを eBay サインインページにリダイレクト → ユーザーが認可後FetchTokenでトークンを取得 - トークン管理:
GetTokenStatusで有効期限を定期確認 → 期限切れ前にユーザーに再認証を促す → 不要になったらRevokeTokenで無効化 - ウォッチリスト機能: バイヤー向けアプリで
AddToWatchList/RemoveFromWatchListを提供し、お気に入り管理を実装 - 知的財産権保護: VeRO 登録権利者が
VeROReportItemsで侵害アイテムを報告 →GetVeROReportStatusで報告の処理状況を追跡
トークン管理(4 コール)
GetSessionID
Auth'n'Auth 認証フローの最初のステップ。eBay からセッション ID を取得します。この ID をパラメータとして eBay のサインインページ URL を構築し、ユーザーをリダイレクトします。ユーザーがアプリケーションを認可すると、このセッション ID を使って FetchToken でトークンを取得できます。
FetchToken
ユーザーが eBay サインインで認可した後、セッション ID を使って認証トークンを取得します。取得したトークンは以後の API コールで認証に使用します。トークンには有効期限(通常 18 ヶ月)があります。
GetTokenStatus
トークンの現在のステータスと有効期限を確認します。トークンが有効か、いつ期限切れになるかを定期的にチェックし、期限切れ前にユーザーに再認証を促すために使用します。
RevokeToken
トークンを無効化します。ユーザーがアプリケーションとの連携を解除する場合や、セキュリティ上の理由でトークンを失効させる場合に使用。無効化されたトークンは以後の API コールで使用できなくなります。
注意: 新規アプリケーションでは OAuth 2.0 認証フローの使用を推奨します。Auth'n'Auth トークンは引き続きサポートされていますが、OAuth がeBay の推奨認証方式です。
ウォッチリスト(2 コール)
AddToWatchList
認証ユーザーのウォッチリストにアイテムを追加します。アイテム ID を指定して最大 10 件を一括追加可能。ウォッチリストの上限は通常 400 アイテム。バイヤー向けアプリケーションの「お気に入り」機能に使用。
RemoveFromWatchList
ウォッチリストからアイテムを削除します。特定のアイテム ID を指定して削除、またはバリエーション ID を指定して特定のバリエーションのみを削除することも可能。
知的財産権保護 — VeRO(3 コール)
VeRO(Verified Rights Owner)プログラムは、eBay の知的財産権保護プログラムです。VeRO 登録権利者は、商標権・著作権・特許権を侵害するリスティングの報告と追跡ができます。
GetVeROReasonCodeDetails
VeRO 報告で使用できる理由コード(商標権侵害、著作権侵害、偽造品など)の一覧と詳細を取得します。報告フォーム作成時に理由コードの選択肢として使用。
VeROReportItems
知的財産権を侵害しているアイテムを eBay に報告します。アイテム ID、理由コード、権利者情報を指定して報告を送信。報告が受理されると、eBay がリスティングの削除等の対応を行います。
GetVeROReportStatus
送信した VeRO 報告の処理ステータスを確認します。報告 ID を指定して、各アイテムの処理結果(受理、却下、処理中など)を取得。