Key Management API

Key Management API 概要 (Key Management API Overview)

バージョン：1.0.0

EUおよび英国（UK）のセラーに適用される規制要件により、特定のAPIについては、開発者がそれぞれのHTTPコールにデジタル署名を追加する必要があります。

Key Management API は、以下のAPIのデジタル署名を作成する際に必要となるキーペアを生成します：

  • Finances API のすべてのメソッド
  • Fulfillment API の issueRefund
  • Trading API の GetAccount
  • Post-Order API の以下のメソッド：
    • Issue Inquiry Refund
    • Issue case refund
    • Issue return refund
    • Process Return Request
    • Approve Cancellation Request
    • Create Cancellation Request

機密性の高い財務情報にアクセスするすべてのeBay APIは、EU/UKに居住する顧客に代わって行われるすべてのHTTPコールにデジタル署名を含める必要があります。これらのデジタル署名を生成するためのキーペアの使用方法に関する完全な情報は、Digital Signatures for APIs ガイドを参照してください。

技術概要 (Technical overview)

Key Management API には、以下のメソッドが含まれています：

  • createSigningKey
  • getSigningKey
  • getSigningKeys

暗号方式 (Ciphers)

Key Management APIは、以下の2つの暗号方式のいずれかを使用して暗号化されたキーペアを生成します：

  • Ed25519 (Edwards Curve)
    Ed25519は、鍵の長さが非常に短く、ヘッダーサイズを小さくできるため、推奨される暗号方式です。詳細については、RFC 8032 を参照してください。
  • RSA
    Ed25519をサポートしていない開発フレームワークのために、eBayはRSAもサポートしています。詳細については、RFC 3447 を参照してください。

createSigningKey

createSigningKey メソッドは、選択された暗号方式を使用して、以下の3つの値を生成し、返します：

  • 秘密鍵 (Private Key)
  • 公開鍵 (Public Key)
  • JWE形式の公開鍵 (Public Key as JWE)

getSigningKey

getSigningKey メソッドは、呼び出しを行っているアプリケーションキーに関連付けられた、指定された signingKeyId に対応する 公開鍵、JWE形式の公開鍵、およびメタデータを返します。

注: 秘密鍵 (Private Key) の値は、createSigningKey 呼び出しのレスポンスペイロードでのみ返されます。クライアントの機密情報のセキュリティを保証するため、eBayはいかなるシステム上にも秘密鍵の値を保存しません。したがって、getSigningKey 呼び出しで秘密鍵が返されることは決してありません。開発者が秘密鍵を紛失した場合は、createSigningKey 呼び出しを行って新しいキーペアセットを生成する必要があります。

getSigningKeys

getSigningKeys メソッドは、呼び出しを行っているアプリケーションキーに関連付けられたすべてのキーペアの 公開鍵、JWE形式の公開鍵、およびメタデータを返します。

注: getSigningKey と同様に、秘密鍵 (Private Key) の値がこのメソッドで返されることはありません。秘密鍵が必要な場合は、必ず createSigningKey を使用して新しいセットを作成してください。

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

Key Management API は、前述のAPIリストにおいて、EU/UKのセラーに代わって行われるすべてのHTTPコールにデジタル署名を追加するために必要なキーペアを作成・取得するために使用されます。

API制限 (API restrictions)

Key Management APIは、マーケットプレイスやユーザーによる制限はありません。

トップに戻る