Client Registration API ドキュメント
開発者クライアント登録 API(Developer Client Registration API)
注: クライアント登録 API は、eBay プラットフォームで以前に開発者アカウントに登録した開発者が使用することを意図したものではありません。
クライアント登録 API は、EU/英国に居住する個人に代わって金融取引を行っている、または行う予定の規制対象のサードパーティプロバイダー(TPP)に動的クライアント登録を提供します。これは、EU の第 2 次決済サービス指令(PSD2)で義務付けられており、規制対象のすべてのアカウントサービス決済サービスプロバイダー(ASPSP)は、アカウント所有者に代わってアカウントおよび決済サービスにアクセスするための安全な API を提供する必要があります。
登録応答が成功すると、登録情報を含む JSON ペイロード [RFC7519] を含む HTTP 201 Created ステータスコードが返されます。
バージョン: v1.0.0
ベースURL: https://api.ebay.com/developer/registration/v1
認証(OAuth スコープ)
この API は クライアント資格情報(Client Credentials) フローを使用します。
| スコープ | 説明 |
|---|---|
https://api.ebay.com/oauth/api_scope | パブリックデータへのアクセス |
重要: registerClient メソッドを呼び出す場合、サードパーティプロバイダー(TPP)は、Mutual Transport Layer Security(MTLS)ハンドシェイクの Certificate Request メッセージを介して、有効な eIDAS 証明書を eBay に渡す必要があります。
リソース一覧
Developer Client Registration API は以下の 1 リソース、合計 1 エンドポイント(POST)で構成されています。
| リソース | 説明 | 数 |
|---|---|---|
| client | サードパーティ金融アプリケーションの登録 | 1 |
client — クライアント登録(1 エンドポイント)
POST /client/register
registerClient — 新しいサードパーティの金融アプリケーションを eBay に登録します。
呼び出しが成功すると、HTTP ステータスコード 201 Created と応答ペイロードが返されます。
複数のアプリケーションの登録
規制対象のサードパーティプロバイダー(一意の organizationIdentifier で識別)は、登録時に各アプリケーションの一意の software_id が渡される場合、最大 15 個の異なるアプリケーションを eBay に登録できます。一意の software_id を渡す各 registerClient 呼び出しは、新しい client_id と client_secret キーペアを生成します。
サードパーティプロバイダーが、以前に登録された software_id を使用して registerClient を呼び出すと、既存の client_id と client_secret キーペアが返されます。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
Content-Type | ヘッダー | 必須 | リクエスト本文の形式。application/json に設定する必要があります。 |
レスポンス: 201 / 400 / 404 / 500
スキーマ定義(全 4 スキーマ)
ClientDetails
| フィールド | 型 | 説明 |
|---|---|---|
client_id | string | 登録されたアプリケーションのクライアント ID |
client_id_issued_at | integer | クライアント ID が発行された時間(Unix タイムスタンプ) |
client_name | string | クライアント名 |
client_secret | string | クライアントシークレット |
client_secret_expires_at | integer | クライアントシークレットの有効期限(Unix タイムスタンプ、0 = 無期限) |
contacts | array[string] | 連絡先メールアドレスの配列 |
policy_uri | string | プライバシーポリシーの URI |
redirect_uris | array[string] | リダイレクト URI の配列 |
scope | string | クライアントに許可されたスコープ |
software_id | string | ソフトウェア識別子 |
software_statement | string | ソフトウェアステートメント(JWT) |
ClientSettings
| フィールド | 型 | 説明 |
|---|---|---|
contacts | array[string] | 連絡先メールアドレスの配列 |
policy_uri | string | プライバシーポリシーの URI |
redirect_uris | array[string] | リダイレクト URI の配列 |
software_id | string | ソフトウェア識別子(一意である必要があります) |
software_statement | string | ソフトウェアステートメント(JWT) |
Error / ErrorParameter
標準エラースキーマ(他の API と同一構造)。
エンドポイント一覧(全 1 エンドポイント)
| メソッド | エンドポイント | operationId | 説明 |
|---|---|---|---|
| POST | /client/register | registerClient | サードパーティ金融アプリケーション登録 |