Key Management API ドキュメント
キー管理 API(Key Management API)
EU/英国のセラーに適用される規制要件により、特定の API では、開発者がそれぞれの HTTP コールにデジタル署名を追加する必要があります。キー管理 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
注: キーペアとメッセージ署名の作成に関する追加情報は、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 に設定。 |
リクエストボディ: CreateSigningKeyRequest — signingKeyCipher フィールドに暗号方式(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
| フィールド | 型 | 説明 |
|---|---|---|
signingKeyCipher | string | キーペア作成に使用する暗号方式。有効値: ED25519、RSA |
SigningKey
| フィールド | 型 | 説明 |
|---|---|---|
creationTime | integer | キーペア作成時の UNIX タイムスタンプ。 |
expirationTime | integer | キーペアの有効期限(UNIX タイムスタンプ)。作成日から 3 年後。 |
jwe | string | 公開鍵の JSON Web Encrypted(JWE)値。 |
privateKey | string | 指定された暗号方式で生成された秘密鍵。createSigningKey のレスポンスでのみ返されます。 |
publicKey | string | 指定された暗号方式で生成された公開鍵。 |
signingKeyCipher | string | キーペア作成に使用された暗号方式。 |
signingKeyId | string | システム生成の eBay キーペア ID。 |
QuerySigningKeysResponse
| フィールド | 型 | 説明 |
|---|---|---|
signingKeys | array[SigningKey] | ユーザーが所有するすべてのキーペアのメタデータ情報の配列。 |
Error / ErrorParameter
標準エラースキーマ(他の API と同一構造)。
エンドポイント一覧(全 3 エンドポイント)
| メソッド | エンドポイント | operationId | 説明 |
|---|---|---|---|
| GET | /signing_key | getSigningKeys | 全キーペア取得 |
| POST | /signing_key | createSigningKey | キーペア作成 |
| GET | /signing_key/{signing_key_id} | getSigningKey | 指定キーペア取得 |