Identity API

Identity API 概要 (Identity API Overview)

バージョン：1.1.0

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

Identity APIは、提供されたOAuthスコープに基づいて、認証済みユーザー（ユーザーアクセストークン）のデータを返します。eBayの userID などの機密ではない情報は、デフォルトのスコープを使用して返されます。住所、メールアドレス、電話番号などの個人の機密データは、呼び出しで使用するOAuthスコープに基づいて返されます。ビジネスユーザーの場合、すべての公開ビジネス情報はデフォルトのOAuthスコープを使用して返されます。

Identity APIを使用すると、ユーザーがeBayを使用してアプリやサイトにログインできるようになります。これにより、開発者がユーザーの個人を特定できる情報（PII）データを保存および保護する必要がなくなります。

注: すべてのスコープにおいて、ユーザーからの明示的な同意が必要です。

技術概要 (Technical overview)

Identity APIは、認証済みユーザーのアカウントプロファイル情報を返す user リソースを使用します。

ビジネスユースケース (Business use cases)

このセクションでは、Identity APIでサポートされている高レベルのユースケースについて説明します。

  • デフォルトスコープを使用したビジネスの公開情報の取得
  • デフォルトスコープを使用した個人の公開情報の取得
  • 他のスコープを使用した個人の追加情報の取得

ビジネスアカウントのレスポンス (Business Account Response)

ビジネスアカウント情報は、利用可能な場合に返されます。このタイプのアカウントは、一部の国でのみ利用可能です。詳細については、accountType を参照してください。

スコープ (Scope) 返されるフィールド
commerce.identity.readonly
(デフォルト) 
{
  "userId": "007BUS2xyeBay",
  "username": "ebaybusinessuser",
  "accountType": "BUSINESS",
  "registrationMarketplaceId": "EBAY_US",
  "businessAccount": {
    "name": "eBay User",
    "email": "ebaybusinessuser@ebay.com",
    "doingBusinessAs": "Top eBay Seller",
    "primaryPhone": {
      "countryCode": "US",
      "number": "0000000000",
      "phoneType": "MOBILE"
    }
  },
  "address": {
    "addressLine1": "2025 Hamilton Ave",
    "addressLine2": "Apt E 2025",
    "city": "San Jose",
    "stateOrProvince": "CA",
    "postalCode": "95125",
    "country": "US"
  },
  "primaryContact": {
    "firstName": "eBay",
    "lastName": "User"
  }
}

個人アカウントのレスポンス (Individual Account Response)

ユーザーの個人情報を保護するため、individualAccount コンテナで返されるフィールドはスコープによって制御されます。すべてのパートナーはデフォルトのスコープを使用でき、ユーザーの公開情報と（存在する場合は）ビジネス情報が返されます。その他のスコープへのアクセスは、パートナーとeBayとの契約で指定されます。

以下の表は、スコープごとに individualAccount コンテナで返されるフィールドを示しています。詳細については、getUser メソッドを参照してください。トークン生成時に関心のあるすべてのスコープを指定することで、複数のスコープから情報を取得できます。

スコープ (Scope) 返されるフィールド
commerce.identity.readonly
(デフォルト) 
{
  "userId": "007IND2xyeBay",
  "username": "ebayindividualuser",
  "accountType": "INDIVIDUAL",
  "registrationMarketplaceId": "EBAY_US"
}
commerce.identity.status.readonly

※ビジネスアカウントのレスポンスでも status フィールドを返します。 
{
  "userId": "007IND2xyeBay",
  "username": "ebayindividualuser",
  "status": "CONFIRMED",
  "accountType": "INDIVIDUAL",
  "registrationMarketplaceId": "EBAY_US"
}
commerce.identity.name.readonly 
{
  "userId": "007IND2xyeBay",
  "username": "ebayindividualuser",
  "accountType": "INDIVIDUAL",
  "registrationMarketplaceId": "EBAY_US",
  "individualAccount": {
    "firstName": "eBay",
    "lastName": "User"
  }
}
commerce.identity.address.readonly 
{
  "userId": "007IND2xyeBay",
  "username": "ebayindividualuser",
  "accountType": "INDIVIDUAL",
  "registrationMarketplaceId": "EBAY_US",
  "individualAccount": {
    "registrationAddress": {
      "addressLine1": "2025 Hamilton Ave.",
      "city": "San Jose",
      "stateOrProvince": "CA",
      "postalCode": "95125",
      "country": "US"
    }
  }
}
commerce.identity.email.readonly 
{
  "userId": "007IND2xyeBay",
  "username": "ebayindividualuser",
  "accountType": "INDIVIDUAL",
  "registrationMarketplaceId": "EBAY_US",
  "individualAccount": {
    "email": "ebayindividualuser@ebay.com"
  }
}
commerce.identity.phone.readonly 
{
  "userId": "007IND2xyeBay",
  "username": "ebayindividualuser",
  "accountType": "INDIVIDUAL",
  "registrationMarketplaceId": "EBAY_US",
  "individualAccount": {
    "primaryPhone": {
      "countryCode": "US",
      "number": "0000000000",
      "phoneType": "MOBILE"
    },
    "secondaryPhone": {
      "countryCode": "US",
      "number": "0000000000",
      "phoneType": "MOBILE"
    }
  }
}

API制限 (API restrictions)

レート制限

Identity APIは、アプリケーションに代わって1日に行うことができる呼び出し数を制限しています。現在のアプリケーションレート制限については、API Call Limits ページを参照してください。

サンドボックスでのテスト

このAPIはサンドボックス環境でテスト可能ですが、模擬データ（mock data）が返されます。

注: 返してほしいデータに対応する正しいスコープを使用する必要があります。
トップに戻る