eBay Public_key API

openapi: 3.2.0
info:
  title: eBay Notification Public Key API
  description: 'The eBay Notification API enables management of the entire end-to-end eBay notification experience by allowing users to:


    Browse for supported notification topics and retrieve topic details


    Create, configure, and manage notification destination endpoints


    Configure, manage, and test notification subscriptions


    Process eBay notifications and verify the integrity of the message payload'
  contact:
    name: eBay Inc,
  license:
    name: eBay API License Agreement
    url: https://developer.ebay.com/join/api-license-agreement
  version: v1.5.1
servers:
- url: https://api.ebay.com{basePath}
  description: Production
  variables:
    basePath:
      default: /commerce/notification/v1
tags:
- name: Public Key
paths:
  /public_key/{public_key_id}:
    get:
      tags:
      - Public Key
      description: '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.


        Important! The retrieved public key value should be cached for a temporary — but reasonable — amount of time (e.g., one-hour is recommended.) This key should not be requested for every notification since doing so can result in exceeding API call limits if a large number of notification requests is received.


        Note: For more details about how to process eBay push notifications and validate notification message payloads, see the Notification API overview.'
      operationId: getPublicKey
      parameters:
      - name: public_key_id
        in: path
        description: 'The unique key ID that is used to retrieve the public key.<br><br><span class="tablenote"><b>Note: </b>This is retrieved from the <b>X-EBAY-SIGNATURE</b> header that is included with the push notification.</span>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicKey'
        '400':
          description: Bad Request
        '404':
          description: Not Found
          x-response-codes:
            errors:
              '195001':
                domain: API_NOTIFICATION
                category: REQUEST
                description: The specified key id is invalid.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '195000':
                domain: API_NOTIFICATION
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope
      summary: Get public key
      x-summary-source: derived
components:
  schemas:
    PublicKey:
      type: object
      properties:
        algorithm:
          type: string
          description: The algorithm associated with the public key that is returned, such as Elliptic Curve Digital Signature Algorithm (ECDSA).
        digest:
          type: string
          description: The digest associated with the public key that is returned, such as Secure Hash Algorithm 1 (SHA1).
        key:
          type: string
          description: The public key that is returned for the specified key ID.<br><br>This value is used to validate the eBay push notification message payload.
      description: A type that defines the public key for a unique key ID.
  securitySchemes:
    api_auth:
      type: oauth2
      description: The security definitions for this API. Please check individual operations for applicable scopes.
      flows:
        clientCredentials:
          tokenUrl: https://api.ebay.com/identity/v1/oauth2/token
          scopes:
            https://api.ebay.com/oauth/api_scope: View public data from eBay
        authorizationCode:
          authorizationUrl: https://auth.ebay.com/oauth2/authorize
          tokenUrl: https://api.ebay.com/identity/v1/oauth2/token
          scopes:
            https://api.ebay.com/oauth/api_scope/commerce.notification.subscription.readonly: View your event notification subscriptions
            https://api.ebay.com/oauth/api_scope/commerce.notification.subscription: View and manage your event notification subscriptions