Identity API ドキュメント

Identity API

Identity API は、認証されたユーザーのアカウントプロファイル情報を取得します。これを使用して、ユーザーが eBay を使用してアプリまたはサイトにログインできるようにすることができます。これにより、ユーザーの PII（個人識別情報）データを保存して保護する必要がなくなります。

注: 認証されたユーザーに対して、アカウント関連のフィールドがすべて返されるわけではありません。応答で返されるフィールドはスコープによって制御され、ビジネスユニットによって承認された特定の開発者のみが使用できます。

バージョン: v2.0.0

ベースURL: https://apiz.ebay.com/commerce/identity/v2

認証（OAuth スコープ）

この API は 認可コード（Authorization Code） フローを使用します。ユーザーの認可が必要です。返されるフィールドは使用するスコープによって制御されます。

スコープ	説明
`https://api.ebay.com/oauth/api_scope/commerce.identity.readonly`	ユーザー名やビジネスアカウントの詳細など、eBay メンバーアカウントの基本情報を表示
`https://api.ebay.com/oauth/api_scope/commerce.identity.name.readonly`	eBay メンバーアカウントのユーザーの姓名を表示
`https://api.ebay.com/oauth/api_scope/commerce.identity.email.readonly`	eBay メンバーアカウントの個人メール情報を表示
`https://api.ebay.com/oauth/api_scope/commerce.identity.phone.readonly`	eBay メンバーアカウントの個人電話情報を表示
`https://api.ebay.com/oauth/api_scope/commerce.identity.address.readonly`	eBay メンバーアカウントの個人住所情報を表示

リソース一覧

Identity API は 1 リソース、1 エンドポイント（GET）で構成されています。

リソース	説明	数
user	認証されたユーザーのアカウントプロファイル情報を取得	1

user — ユーザー情報の取得（1 エンドポイント）

GET `/user/`

getUser — 認証されたユーザーのアカウントプロファイル情報を取得します。ユーザーアクセストークンが必要です。

アカウントタイプ別の動作:

ビジネスアカウント — デフォルトスコープ commerce.identity.readonly を使用すると、businessAccount コンテナ内のすべてのフィールド（公開情報）が返されます。
個人アカウント — individualAccount コンテナで返されるフィールドは使用するスコープに依存します。デフォルトスコープでは eBay ユーザー ID などの公開情報のみ返されます。

注: サンドボックスではモックデータが返されます。正しいスコープを使用する必要があります。

パラメータ: なし（認証トークンのみ必要）

レスポンス: 200 → UserResponse / 404 / 500

スキーマ定義（全 8 スキーマ）

ユーザー

UserResponse

フィールド	型	説明
`userId`	string	eBay ユーザー ID
`username`	string	eBay ユーザー名
`accountType`	string	アカウントタイプ: `INDIVIDUAL` / `BUSINESS`
`status`	string	アカウントステータス
`registrationMarketplaceId`	string	登録マーケットプレイス ID
`individualAccount`	IndividualAccount	個人アカウント情報（個人アカウントの場合）
`businessAccount`	BusinessAccount	ビジネスアカウント情報（ビジネスアカウントの場合）

IndividualAccount

フィールド	型	説明
`firstName`	string	名（`identity.name.readonly` スコープが必要）
`lastName`	string	姓（`identity.name.readonly` スコープが必要）
`email`	string	メールアドレス（`identity.email.readonly` スコープが必要）
`primaryPhone`	Phone	主要電話番号（`identity.phone.readonly` スコープが必要）
`secondaryPhone`	Phone	副電話番号（`identity.phone.readonly` スコープが必要）
`registrationAddress`	Address	登録住所（`identity.address.readonly` スコープが必要）

BusinessAccount

フィールド	型	説明
`name`	string	ビジネス名
`doingBusinessAs`	string	屋号（DBA）
`address`	Address	ビジネス住所
`email`	string	メールアドレス
`primaryPhone`	Phone	主要電話番号
`secondaryPhone`	Phone	副電話番号
`primaryContact`	Contact	主要連絡先
`website`	string	ウェブサイト URL

共通スキーマ

Address

フィールド	型	説明
`addressLine1`	string	住所行 1
`addressLine2`	string	住所行 2
`city`	string	市区町村
`stateOrProvince`	string	都道府県/州
`postalCode`	string	郵便番号
`county`	string	郡
`country`	string	国コード（ISO 3166-1 alpha-2）

Phone

フィールド	型	説明
`countryCode`	string	国コード（例: 1, 81）
`number`	string	電話番号
`phoneType`	string	電話タイプ: `HOME`, `WORK`, `MOBILE`

Contact

フィールド	型	説明
`firstName`	string	名
`lastName`	string	姓

Error

フィールド	型	説明
`category`	string	エラーカテゴリ
`domain`	string	エラードメイン
`errorId`	integer	エラー ID
`message`	string	短いメッセージ
`longMessage`	string	詳細メッセージ
`inputRefIds`	array[string]	入力参照 ID
`outputRefIds`	array[string]	出力参照 ID
`parameters`	array[ErrorParameter]	エラーパラメータ
`subdomain`	string	エラーサブドメイン

ErrorParameter

フィールド	型	説明
`name`	string	パラメータ名
`value`	string	パラメータ値

エンドポイント一覧（全 1 エンドポイント）

メソッド	エンドポイント	operationId	説明
GET	`/user/`	getUser	認証されたユーザーのアカウントプロファイル情報を取得