Key Management API ドキュメント

キー管理 API(Key Management API)

EU/英国のセラーに適用される規制要件により、特定の API では、開発者がそれぞれの HTTP コールにデジタル署名を追加する必要があります。キー管理 API は、以下の API のデジタル署名を作成する際に必要なキーペアを作成します:

  • Finances API のすべてのメソッド
  • Fulfillment APIissueRefund
  • Trading APIGetAccount
  • Post-Order API: Issue Inquiry Refund、Issue case refund、Issue return refund、Process Return Request、Approve Cancellation Request、Create Cancellation Request

注: キーペアとメッセージ署名の作成に関する追加情報は、API のデジタル署名を参照してください。

バージョン: v1.0.0

ベースURL: https://apiz.ebay.com/developer/key_management/v1

認証(OAuth スコープ)

この API は クライアント資格情報(Client Credentials) フローを使用します。

スコープ説明
https://api.ebay.com/oauth/api_scopeパブリックデータへのアクセス

リソース一覧

Key Management API は以下の 1 リソース、合計 3 エンドポイント(2 GET + 1 POST)で構成されています。

リソース説明
signing_keyデジタル署名用キーペアの作成と管理3

signing_key — キーペア管理(3 エンドポイント)

GET /signing_key

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

注: privateKey 値は返されません。eBay は機密クライアント情報のセキュリティを確保するため、いかなるシステムにも privateKey 値を保存しません。開発者が秘密鍵を紛失した場合、createSigningKey メソッドで新しいキーペアを生成する必要があります。

レスポンス: 200 / 400 / 401 / 403 / 500

POST /signing_key

createSigningKey — 以下のいずれかの暗号方式を使用してキーペアを作成します:

  • ED25519(エドワーズ曲線)— 推奨。より短いキーを使用し、ヘッダーサイズが小さくなります。
  • RSA — ED25519 をサポートしない開発フレームワーク向け。

作成に成功すると、秘密鍵公開鍵JWE としての公開鍵が返されます。

重要! 開発者はキーペア作成後にローカルコピーを作成して保存することを強く推奨します。eBay は秘密鍵の値をいかなるシステムにも保存しません。秘密鍵は createSigningKey のレスポンスでのみ返されます。

パラメータ場所必須説明
Content-Typeヘッダー必須application/json に設定。

リクエストボディ: CreateSigningKeyRequestsigningKeyCipher フィールドに暗号方式(ED25519 または RSA)を指定。

レスポンス: 200 / 400 / 401 / 403 / 500

GET /signing_key/{signing_key_id}

getSigningKey — 指定された signingKeyId に関連付けられたキーペアの公開鍵、JWE としての公開鍵、およびメタデータを返します。秘密鍵は返されません。

パラメータ場所必須説明
signing_key_idパス必須システム生成の eBay キーペア ID。

レスポンス: 200 / 400 / 401 / 403 / 404 / 500

スキーマ定義(全 5 スキーマ)

CreateSigningKeyRequest

フィールド説明
signingKeyCipherstringキーペア作成に使用する暗号方式。有効値: ED25519RSA

SigningKey

フィールド説明
creationTimeintegerキーペア作成時の UNIX タイムスタンプ。
expirationTimeintegerキーペアの有効期限(UNIX タイムスタンプ)。作成日から 3 年後。
jwestring公開鍵の JSON Web Encrypted(JWE)値。
privateKeystring指定された暗号方式で生成された秘密鍵。createSigningKey のレスポンスでのみ返されます。
publicKeystring指定された暗号方式で生成された公開鍵。
signingKeyCipherstringキーペア作成に使用された暗号方式。
signingKeyIdstringシステム生成の eBay キーペア ID。

QuerySigningKeysResponse

フィールド説明
signingKeysarray[SigningKey]ユーザーが所有するすべてのキーペアのメタデータ情報の配列。

Error / ErrorParameter

標準エラースキーマ(他の API と同一構造)。

エンドポイント一覧(全 3 エンドポイント)

メソッドエンドポイントoperationId説明
GET/signing_keygetSigningKeys全キーペア取得
POST/signing_keycreateSigningKeyキーペア作成
GET/signing_key/{signing_key_id}getSigningKey指定キーペア取得
トップに戻る