Beginning May 1, 2019, we will start to deprecate the ability to use a JSESSION ID to authenticate API calls. If you currently use the JSESSION method, you will have 1 year to switch your systems to the OAuth login method. Additionally, if your organization was created after April 30, 2019, OAuth will be the only option of authentication that is available to you. If you have any questions about migrating onto the OAuth process, contact your CSM or Support.
 

Our Username/Password paradigm for authenticating against both our UI and our API will continue to be supported, but is considered to be a legacy feature. This approach allows your external systems to securely store a customer-defined integration user’s credentials within them to subsequently authenticate and gain access to the Watson Campaign Automation.

Note: After completing the API actions, you must use a Logout request to close and invalidate the session. The methods used for authenticating against Engage with JSESSIONIDs are as follows.

User Login

Login

Before calling any operation, you must obtain a Jsession ID using the Login operation as shown below.

Operation 

<Login> 

   
Elements  USERNAME Watson Campaign Automation user’s name.   
   PASSWORD  Watson Campaign Automation user’s password.  
Example
<Envelope>
  <Body>
    <Login>
      <USERNAME></USERNAME>
      <PASSWORD>userpassword</PASSWORD>
    </Login>
  </Body>
</Envelope>

  

Response <RESULT>    
Elements  SUCCESS TRUE Always set to TRUE for successful login.
   SESSIONID System-generated session ID.  
   SESSION_ENCODING Encoding of the system-generated session ID. The format for SESSION_ENCODING is as follows: ;jsessionid=SESSIONID where SESSIONID is the system-generated session ID returned.  
   ORGANIZATION_ID Identifies your Watson Campaign Automation Organization.  
Example
<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>true</SUCCESS>
      <SESSIONID>dc302149861088513512481</SESSIONID>
      <SESSION_ENCODING>;jsessionid=dc302149861088513512481
      </SESSION_ENCODING>
    </RESULT>
  </Body>
</Envelope>

  

User Logout

Logout

After completing the API actions, you must use a Logout request to close and invalidate the session, as shown below.

This API call is important both from the perspective of better securing your customer data from hackers as well as allows our servers to perform optimally for your subsequent calls.

Operation  <Logout>     
Elements   None   
Example
<Envelope>
  <Body>
    <Logout/>
  </Body>
</Envelope>
   
Response <RESULT>    
Elements  SUCCESS  TRUE To successfully log off the system, always set to TRUE. 
Example  

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
    </RESULT>
  </Body>
</Envelope>
   

Join The Discussion

Your email address will not be published. Required fields are marked *