Skip to main content
Published: February 24 2009, 12:04:00 PMUpdated: November 28 2020, 5:04:09 PM

How to interact with Open eBay Framework? Do you have a sample application that demonstrate the process?


To interact with Open eBay you need to set up a listener for the following user events:

    1.  Subscribe and Unsubscribe

    2.  Start application

Detailed Description

1. When the Subscribe/Unsubscribe button is clicked. 
    a) The Open eBay Participant Interface service calls addSubscriber or removeSubscriber API as below, appends the cmd=addSubscriber or cmd=removeSubscriber parameter and sends to the EndPoint.Management URL specified in your DD. The subscriber's information including User Auth Token, UserID and User's EIASToken is also passed in addSubscriber API request.  


<addSubscriberRequest xmlns="" xmlns:sct="" xmlns:ms=""> 
<ms:recipient appId="xxx" /> 
<ms:sender appId="com.ebay.echo"> 
<ms:token expirationDate="2010-07-09T12:08:49.000-07:00" issuingAuthority="ECHO" type="Value">
<ms:userName>User Name</ms:userName>
<ms:authToken issuingAuthority="ECHO" type="Value">
<ms:tokenValue>User Auth Token </ms:tokenValue>
<ms:subscriptionData />


<removeSubscriberRequest xmlns="" xmlns:sct="" xmlns:ms=""> 
<ms:recipient appId="xxx" /> 
<ms:sender appId="com.ebay.echo"> 
<ms:token expirationDate="2009-02-19T16:50:03.541-07:00" issuingAuthority="ECHO" type="Value">

   b) Upon receiving the subscription request, you should make the OpeneBayIdentityProviderService.authenticate request to verify the sender.tokenValue passed in the subscription calls

   c) Then, your application needs to send addSubscriberResponse with Approved status to allow the user to access your application and removeSubscriberResponse to indicate you have received the request. Here are the sample addSubscriberResponse and removeSubscriberResponse payloads. 


<addSubscriberResponse xmlns="">
<timestamp>2009-2-17 00:00:00 06:00</timestamp>
<subscriptionStatus status="Approved">
<subscriptionMessage>Subscription Approved</subscriptionMessage>

<removeSubscriberResponse xmlns="">
<removeSubscriberResponse xmlns="">
<timestamp>2009-2-17 00:00:00 06:00</timestamp>

 c) Keep in mind that Open eBay Participant Interface only supports HTTP post method.

2. After a user is successfully subscribed, the Start button would be activated. When the Start button is clicked:
The Open eBay Framework appends the sessionId parameter as sessionId=5d0d555d44d343534594d3453456e4236re44 and sends a Start HTTP request to EndPoint.InSession URL specified in your DD.
  c) Your application makes OpeneBayApplicationIntegrationService.getSession API request:
         - specify the received sessionId in the request and sends the request as below:


 <soap:Envelope xmlns:soap="" xmlns:ser="">

    - render your application when the getSessionResponse is successfully returned to you with the <subscriberInfo> container.

3.  Attached Echo.war is the sample Java Servlet application that demostrates the steps described above. There are two servlets: SubscriberServlet and SessionServlet and which are for listening the Subscribe/Unsubscribe  and Start user events.   
     To use the Echo servlet application, you just need to specify your Open eBay Developer key set and your client application URL as below in the WEB-INF/configuration.xml file:

    <entry key="APPNAME">YOUR ECHO AppName</entry>
    <entry key="DEVNAME">YOUR DevName</entry>
    <entry key="CERT">YOUE ECHO CERT</entry>
    <entry key="PROTOCOL">SOAP12</entry>

   The application is tested under JDK1.6 and Tomcat 6.0.

   NOTE. The source code is available in the attached archived NetBeans procject file:


How well did this answer your question?