notification APIv1.2.0

getPublicKey

GET
/public_key/{public_key_id}
This method allows users to retrieve a public key using a specified key ID. The public key that is returned in the response payload is used to process and validate eBay notifications.

The public key ID, which is a required request parameter for this method, is retrieved from the Base64-encoded X-EBAY-SIGNATURE header that is included in the eBay notification.

Note: For more details about how to process eBay push notifications and validate notification message payloads, see the Notification API overview.

Input

Resource URI (production)

GET https://api.ebay.com/commerce/notification/v1/public_key/{public_key_id}

URI parameters

ParameterTypeDescription
public_key_idstringThe unique key ID that is used to retrieve the public key.

Note: This is retrieved from the X-EBAY-SIGNATURE header that is included with the push notification.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope

See OAuth access tokens for more information.

Output

HTTP response headers

{ /* PublicKey */
"digest" : "string",
"key" : "string"
}
Output container/fieldTypeDescription
algorithmstringThe algorithm associated with the public key that is returned, such as Elliptic Curve Digital Signature Algorithm (ECDSA).

Occurrence: Always

digeststringThe digest associated with the public key that is returned, such as Secure Hash Algorithm 1 (SHA1).

Occurrence: Always

keystringThe public key that is returned for the specified key ID.

This value is used to validate the eBay push notification message payload.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200OK
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
195000API_NOTIFICATIONAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
195001API_NOTIFICATIONREQUESTThe specified key id is invalid.

Warnings

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retrieve a Public Key

This sample retrieves a public key using a specified key ID.

Input

The input is public_key_id.
GET
https://api.ebay.com/commerce/notification/v1/public_key/9936261a-7d7b-4621-a0f1-96ccb428af49

Output

If the call is successful, the public key is returned for the specified key ID.