Responsys Interact January Cherry Ave. 5 th Floor San Bruno, CA

Transcription

1 Interact Campaign Interact Web Services API Developer Guide Responsys Interact January Cherry Ave. 5 th Floor San Bruno, CA

2 Table of Contents Table of Contents INTERACT WEB SERVICES API 8 Interact API Functionality 9 What s New in the Interact API for Interact Campaign 5.16 (January 2011) 10 What s New in the Interact API for Interact Campaign 5.14 (June 2010) 10 What s New in the Interact API for Interact Campaign 5.13 (January 2010) 10 What s New in the Interact API for Interact Campaign 5.12 (September 2009) 11 What s New in the Interact API for Interact Campaign 5.11 (July 2009) 12 What s New in the Interact API for Interact Campaign 5.10 (April 2009) 13 What s New in the Interact API for Interact Campaign 5.9 (February 2009) 14 What s New in the Interact API for Interact Campaign 5.8 (October 2008) 15 What s New in the Interact API for Interact Campaign (September 2008) 16 Interact API URLs 18 Security Considerations 18 Web Service Standards Compliance 19 Development Environments 19 Interact Platform Maintenance and Downtime 19 Backward Compatibility 19 INTERACT PLATFORM AND DATA MODEL OVERVIEW 20 INTERACT OBJECT AND DATA MODEL 20 Campaigns 21 Forms 21 Data Sources 21 Documents 22 Interact API Guide Page 2 of 107 Responsys Confidential

3 Table of Contents INTERACT API GETTING STARTED 23 General Steps 23 For Java Applications 23 For C# Applications 28 INTERACT API CALLS 30 SESSION MANAGEMENT API CALLS 30 Login 30 Logout 32 GetServerTimestamp 34 FOLDER MANAGEMENT API CALLS 35 CreateFolder 35 DeleteFolder 37 ListFolders 39 ListFolderContents 41 ListFolderObjects 43 ImportFolder 46 ExportFolder 48 DATA MANAGEMENT API CALLS 50 CreateDataSource 50 UpdateDataSource 52 UpdateDataSourceUsingMultipleColumns 53 AppendDataSource 54 CopyDataSource 55 CopyDataSourceToTable 56 CreateSQLDataSource 57 Interact API Guide Page 3 of 107 Responsys Confidential

4 Table of Contents DeleteDataSource 58 TruncateTable 59 DownloadDataSourceByTimestamp 60 DownloadDataSource 61 PurgeDataSourceByTimestamp 62 PurgeDataSource 63 ScrubDataSource 64 CheckResult 65 Cancel 66 AddIndex 67 DeleteIndex 68 ListIndexes 69 GetDataSourceSchema 70 GetDataSourceRecordCount 71 CONTENT MANAGEMENT API CALLS 72 UploadDocument 72 RemoveDocument 73 CopyDocument 74 ShowDocument 75 CAMPAIGN MANAGEMENT API CALLS 76 CreateCampaign 76 CopyCampaign 77 DeleteCampaign 78 GetCampaignProperties 79 SetCampaignProperties 80 Interact API Guide Page 4 of 107 Responsys Confidential

5 Table of Contents LaunchCampaign 81 UnScheduleCampaign 82 GetCampaignStatus 82 StopCampaign 83 TriggerFormRules 84 GetLiveReportMetrics 85 GetReportOptions 86 GetCampaignsInDatamart 87 GetLaunchesInDatamart 89 RunLaunchReport 91 RunTriggeredMessageReport 92 INTERACT API TYPE DEFINITIONS 93 PRIMITIVE TYPE DEFINITIONS 93 boolean 93 string 93 int and long 93 datetime 93 INTERACT API TYPE DEFINITIONS 94 CampaignInfo 94 CampaignLaunchType 94 CampaignProperties 94 CampaignPurpose 96 CampaignState 96 CampaignType 96 CampaignVariable 96 Interact API Guide Page 5 of 107 Responsys Confidential

6 Table of Contents CharacterEncoding 97 ClickThru 97 ClickthroughCount 97 DataSourceProperties 97 Document 98 DocumentFile 98 DocumentType 98 Format 99 Field 99 FieldMap 99 FilterObjectType 99 FolderContentType 99 FolderImport 99 FolderObject 100 FormData 100 HtmlData 100 Index 100 InteractObject 100 InteractObjectType 101 IntermediateResult 101 LaunchInfo 101 LiveReportMetrics 102 LiveReportPeriod 102 Log Table 102 LogTableType 103 LoginResult 103 Interact API Guide Page 6 of 107 Responsys Confidential

7 Table of Contents OptOut 103 OptOutMode 103 PurgeDataSourceProperties 104 RecipientLocale 104 RecordCount 105 Report 106 ReportOptions 106 ReportResult 106 ResponsePeriod 107 ScrubProperties 107 ScheduleFrequency 107 Interact API Guide Page 7 of 107 Responsys Confidential

8 Interact API Functionality Interact Web Services API The Interact Web Services Application Programming Interface (Interact API) gives your developers standardsbased access to many of the data, content, and campaign management features of Responsys Interact Campaign. With the Interact API, you can build your own bi-directional data transfers, campaign management customization applications, and other applications that need to interface with your Interact account from a remote location. You may want to use the Interact API to: Synchronize or replicate data between Interact and your enterprise systems Build your own campaign creation workflow. Build your own reporting dashboard that is driven from report metrics and data downloaded from Interact. A conceptual diagram of the use of the Interact API is shown below. Because the Interact API is based on service-oriented architecture (SOA) and industry-standard technologies like SOAP and WSDL, your developers can use their choice of development tools to gain programmatic access to your organization s Responsys Interact account. The Interact API enables easy integration of your enterprise systems with the campaigns and data stored in your Responsys Interact account, enabling greater automation of marketing tasks and processes. Interact API Guide Page 8 of 107 Responsys Confidential

9 Interact API Functionality Interact API Functionality The Interact API supports a subset of the functionality of the Interact user interface as outlined below. Session Management Login/Logout of a Web Services session Get the Interact platform timestamp for data synchronization logic Folder and Interact Object Management Create or deleting folders Import or export Interact folder archive files Retrieve folder and folder object information List and Data Management Create, append, update or delete records in table data source by uploading delimited text files Delete records based on timestamp comparisons Create SQL view objects Download and purge data Copy, scrub, delete, or truncate a data source Obtain data object schema information Add, delete, or list indexes on a table Content Management Upload a message document and image files Copy or delete a document Campaign Management Create a campaign, or change its properties Copy or delete a campaign Launch, stop a launch, or unschedule a campaign Get campaign launch status Get report metrics for a campaign Form Management Trigger form rules to insert/update a record in an existing table and/or trigger a message from a campaign. Interact API Guide Page 9 of 107 Responsys Confidential

10 What s New in the Interact API for Interact Campaign 5.16 (January 2011) What s New in the Interact API for Interact Campaign 5.16 (January 2011) The 5.16 Interact Campaign release introduces the following enhancements and bug fixes: 1. New API call for copying a filter, SQL, or Join view to a static table: copydatasourcetotable() 2. Note: Additions to the Interact API for this release did not necessitate a versioning of the WSDL. Therefore, your client applications do not have to be migrated to new web service endpoint URL, and should continue to use the WSDL and web service endpoint introduced in the 5.7 release of Interact Campaign. What s New in the Interact API for Interact Campaign 5.14 (June 2010) The 5.14 Interact Campaign release introduces the following enhancements and bug fixes: 3. New API call for copying a filter, SQL, or Join view to a static table: copydatasourcetotable() 4. Fix for a defect that caused an unexpected expection when uncompressed files of sizes greater 10 MBs were used with the appenddatasource API call. (Defect #7191) 5. Fix for a defect where client applications were unable to unschedule campaign launches for accounts that contained a time zone setting other than Pacific Time. (Defect #7193) 6. The downloaddatasourcebytimestamp() no longer requires a restriction operator for timestamp or equality comparisons. Specifically, this call can now be used to download all records from a data source. (Defect #7325) Note: Additions to the Interact API for this release did not necessitate a versioning of the WSDL. Therefore, your client applications do not have to be migrated to new web service endpoint URL, and should continue to use the WSDL and web service endpoint introduced in the 5.7 release of Interact Campaign. What s New in the Interact API for Interact Campaign 5.13 (January 2010) The 5.13 Interact Campaign release introduces several new API calls, some behavior changes, and a number of bug fixes. 1. Interact Login restrictions: Client Login IP restrictions that are managed via the Interact Account Admin page now also apply to API sessions as well as UI sessions. 2. You can no longer attempt concurrent merge or purge operations on the same data source. If this is attempted, an error message will be returned. 3. New API call for downloading a compressed file of data by timestamp filtering: downloaddatasourcebytimestamp() 4. New API call for purging data from a data source: purgedatasourcebytimestamp() Interact API Guide Page 10 of 107 Responsys Confidential

11 What s New in the Interact API for Interact Campaign 5.12 (September 2009) Note: Additions to the Interact API for this release did not necessitate a versioning of the WSDL. Therefore, your client applications do not have to be migrated to new web service endpoint URL, and should continue to use the WSDL and web service endpoint introduced in the 5.7 release of Interact Campaign. What s New in the Interact API for Interact Campaign 5.12 (September 2009) No changes were made to the Interact API for the 5.12 Interact Campaign release. Interact API Guide Page 11 of 107 Responsys Confidential

12 What s New in the Interact API for Interact Campaign 5.11 (July 2009) What s New in the Interact API for Interact Campaign 5.11 (July 2009) The 5.11 Interact Campaign release introduces one new API call and a number of bug fixes. 1. A new Interact API call has been added to allow for deleting records in bulk from a data source: purgedatasource() 2. A number of bugs have been fixed: a. updatedatasource() call did not support pipe delimited zip file (6258). b. appenddatasource() call was no properly handling field mappings where the incoming field had a different name than the target table column (6223, 6153). c. appenddatasource() call was not properly generating TIMESTAMP_ values for appended records if the target table contained any field with memo field type (6246). d. updatedatasource() was not working correctly if the delimited text file had different number or different order of columns than the destination datasource (6202). e. When an incoming data file contained a TIMESTAMP_ field, the field mapping was performed incorrectly when creating or uploading into a data source (6243). Note: Additions to the Interact API for this release did not necessitate a versioning of the WSDL. Therefore, your client applications do not have to be migrated to new web service endpoint URL, and should continue to use the WSDL and web service endpoint introduced in the 5.7 release of Interact Campaign. Interact API Guide Page 12 of 107 Responsys Confidential

13 What s New in the Interact API for Interact Campaign 5.10 (April 2009) What s New in the Interact API for Interact Campaign 5.10 (April 2009) The 5.10 Interact Campaign release introduces several new API calls, and a number of bug fixes. 1. New calls have been added to the Interact API. a. Reporting APIs i. getreportoptions() ii. getcampaignsindatamart() iii. getlaunchesindatamart() iv. runlaunchreport() v. runtriggeredmessagereport() b. Data merge API for multicolumn match rules: see updatedatasourceusingmultiplecolumns() 2. Behavior changes: Campaign launch limits: a campaign can no longer be launched with a frequency greater than once every 15 minutes. For high frequency launching applications, Responsys Real-Time Messaging or Form-based triggering should be considered. Contact your account manager or Responsys Support for more information about these triggering options. 3. Bug fixes and performance enhancements a. The performance and stability of merge operations with the updatedatasource call has been improved (3933, 5754, 5890). b. Creation of SQL objects is now fixed for edge cases where a table alias is a portion of a column name (5845). Note: Additions to the Interact API for this release did not necessitate a versioning of the WSDL. Therefore, your client applications do not have to be migrated to new web service endpoint URL, and should continue to use the WSDL and web service endpoint introduced in the 5.7 release of Interact Campaign. Interact API Guide Page 13 of 107 Responsys Confidential

14 What s New in the Interact API for Interact Campaign 5.9 (February 2009) What s New in the Interact API for Interact Campaign 5.9 (February 2009) The 5.9 Interact Campaign release introduces several new API calls, and a number of bug fixes. 1. New calls have been added to the Interact API: a. listfolderobjects b. triggerformrules c. getlivereportmetrics 2. New restrictions Maximum concurrent Interact API logins: a limit on the number of concurrent logins has been implemented to better protect the Interact platform from inadvertant abuse by client applications that would lead to performance degradation for all client applications. This limit is set to 10 by default. If your integration projects require a higher limit, contact Responsys Support to discuss increasing this limit for your account. 3. Bug fixes: a. Data is not appended or updated if the incoming field name does not match the target field name (5373). b. TIMESTAMP_ field values are not generated in some cases for append and update operations (5157). Note: Additions to the Interact API for this release did not necessitate a versioning of the WSDL. Therefore, your client applications do not have to be migrated to new web service endpoint URL, and should continue to use the WSDL and web service endpoint introduced in the 5.7 release of Interact Campaign. Interact API Guide Page 14 of 107 Responsys Confidential

15 What s New in the Interact API for Interact Campaign 5.8 (October 2008) What s New in the Interact API for Interact Campaign 5.8 (October 2008) The 5.8 Interact Campaign release introduces several new API calls, and a number of bug fixes. 1. New calls have been added to the Interact API: 2. Bug fixes: a. getservertimestamp b. truncatetable c. addindex d. deleteindex e. listindexes a. When copydatasource is called, data extraction keys are now copied to the new data source. b. From Address for a campaign can now be changed with the setcampaignproperties call. Note: The From Address must already be defined for use in your Interact Campaign account. Note: Additions to the Interact API for this release did not necessitate a versioning of the WSDL. Therefore, your client applications do not have to be migrated to new web service endpoint URL, and should continue to use the WSDL and web service endpoint introduced in the 5.7 release of Interact Campaign. Interact API Guide Page 15 of 107 Responsys Confidential

16 What s New in the Interact API for Interact Campaign (September 2008) What s New in the Interact API for Interact Campaign (September 2008) The Responsys Interact release introduces a series of enhancements and bug fixes for the Interact Interact API. 1. New Web Service Endpoint URLs and WSDLs have been introduced to support this new Interact API version. The Web Service Endpoint URLs for the previous Interact API version will continue to be supported and your existing client applications should not be impacted. You should make plans to migrate to the new Interact API version to take advantage of recent enhancements. 2. Data APIs that involve file handling are now based on W3C SOAP Message Transfer Optimization Mechansism (MTOM) as opposed to previous versions of these APIs which were based on MIME and DIME attachments. This enhancement and other bug fixes should eliminate previously observed issues with the upload of large data files. 3. Support for synchronous Data API options has been removed. New Data API calls are now based on an asynchronous approach where a data file upload is initiated with one API call and the progress toward completion of that upload is checked with another API call. For more information on these changes, refer to the Data Management and checkresult API calls described in this guide. 4. Login API call now returns an session ID string that should be placed in the SOAP header of all subsequent API calls to authenticate the client application request. 5. CampaignProperties object has been extended to include new property access: a. It now supports retrieving the Interact Campaign identifier as well as the setting and getting an External Campaign identifier. b. CampaignProperties now includes campaignpurpose property which takes an enum with values of PROMOTIONAL or TRANSACTIONAL. 6. Superfluous namespaces have been removed from the SOAP responses of API calls to make the XML more readable and compact. 7. A number of new obects have been introduced to allow cleaner API calls: InteractObject. For example, previously separate object types included AcknowledgmentDocument, Attachment, ClickTrack, DistributionList, FollowUp, ResponseDB, SeedList, SupplementalDataSource, and SuppressionDataSource. Since these are merely Interact obects with a folder and name property, a more generic obect, called the InteractObject is now used for these former objects. 8. We have added the following new enumerated types for enhanced usability: a. CampaignType (STANDARD, FORM, REALTIME) used in createcampaign. b. ScheduleFrequency (ONCE, DAILY, WEEKLY, MONTHLY) used in launchcampaign. c. LogTableType (SENT, FAILED) used in the LogTable element. d. DocumentType (AOL, HTML, TEXT) used in the Document element. e. OptOutMode (NONE, ONE_STEP, TWO_STEP, USER_URL) used in the OptOut element. f. FieldType (STR25, STR50, STR255, STR1000, MEMO, NUMBER, INTEGER, TIMESTAMP), used in Field element. g. FolderContentType (DATA, CAMPAIGN, DOCUMENT, REPORT, RULE, ALL_TYPES) used instead of the contenttype string. Interact API Guide Page 16 of 107 Responsys Confidential

17 What s New in the Interact API for Interact Campaign (September 2008) h. FolderContentType (DATA, CAMPAIGN, DOCUMENT, REPORT, RULE, ALL_TYPES used instead of the contenttype string in listfoldercontents API. i. RecipientLocale (all supported locale strings) 9. Added the following new elements 10. Bug fixes: a. New string element optouturl in the OptOut complextype. The new element will be used if the mode is USER_URL. b. New element Field which contains fieldname string & fieldtype enum, used in the DataSourceProperties. c. New locale element in DocumentFile complextype. a. When a campaign is launched via an API call, the conversion tracking property is no longer set to false (4025). b. When a campaign is created from campaign template that includes link tracking and its document is changed, link tracking is no longer disabled (4057). c. Use of setcampaignproperties to set a Link Table that was created with an API copy operation is now possible (4115). 11. Java sample code has been revised based on the use of Apache Axis2 1.4 to generate Java stub classes (previous samples were based on Axis 1.x). Interact API Guide Page 17 of 107 Responsys Confidential

18 Interact API URLs Interact API URLs When your account is enabled for access to the Interact API, the Responsys Support team will provide you with the Interact API URLs needed to develop your projects. Interact API URLs for several available Responsys Interact instances are provided below for preliminary reference only. Responsys Interact Pod Interact 1 Pod (interact1.responsys.net) Interact 3 Pod (interact3.responsys.net) Interact 4 Pod (interact4.responsys.net) Interact EMEA Pod (interact.ruk1.net) Web Service API URLs Security Considerations Communications between your client application and the Interact Campaign Interact API can be secured by using the Secure Sockets Layer (SSL) protocol for HTTP requests and responses. This is a standard approach for securing internet-based communications and was designed to prevent eavesdropping, tampering, and message forgery. It secures communications over the internet by cryptographic methods based on a 128-bit encryption and is a standard approach for securing SOAP-based Web service transactions. Interact API Guide Page 18 of 107 Responsys Confidential

19 Web Service Standards Compliance Web Service Standards Compliance The Interact API was implemented in compliance with the following specifications. Simple Object Access Protocol (SOAP) Web Service Description Language (WSDL) WS-I Basic Profile Development Environments The Interact API works with modern SOAP development environments, including, but not limited to, Visual Studio.NET 2005 and Apache Axis. Development platforms vary in their SOAP implementations. Implementation differences in certain development platforms might prevent access to some or all of the features in the API. If you are using Visual Studio for.net development, we recommend that you use Visual Studio 2003 or higher. Interact Platform Maintenance and Downtime The Responsys Interact platform will undergo maintenance downtimes on a monthly or bi-monthly schedule. During these downtimes, Interact Campaign login sessions will not be available. Attempts to create a login session will return an error and client applications will need to take the appropriate action, which may include alerts to support staff, integration job queuing, and/or scheduled re-attempts. Backward Compatibility Responsys supports backward compatibility as new versions of the Interact API are released. The Interact API is backward compatible in that an application created to work with a given Interact API version will continue to work with that same Interact API version in future platform releases. Specifically, the Interact API endpoint URL is versioned so that different Interact API versions have different endpoint URLs. Your applications will continue to work with the Interact API endpoint URLs of previous releases and you have the opportunity to migrate your client applications to the newer Interact API version endpoint URLs to leverage enhanced functionality on a schedule that meets your needs. Responsys does not guarantee that an application written against one Interact API version will work with future API versions since changes in method signatures and data representations are often required as we continue to enhance the Interact platform; however, we strive to keep the Interact API consistent from version to version with minimal if any changes required to port applications to newer Interact API versions. When an API version is to be deprecated, advance end-of-life notice will be given at least 6 months before support for the API version is ended. Responsys will directly notify customers using API versions planned for deprecation. Interact API Guide Page 19 of 107 Responsys Confidential

20 Backward Compatibility Interact Platform and Data Model Overview Since 1998, Responsys has been a technology leader and innovator in the marketing industry, delivering highquality campaign management software as a service over the Internet. Best known as the industry s #1-ranked marketing solution, Responsys Interact today is a comprehensive on-demand marketing platform with a fully integrated suite of software applications all built from the ground up on a single-instance, multi-tenant architecture. Interact Object and Data Model In the Interact Campaign user interface, you create and manage a variety of application objects that are needed to execute your marketing programs. The Interact Campaign object model consists of the following types of objects. Campaigns Allow users to execute individual campaigns in batch or triggered modes Forms Allow users to collect data via web forms Data sources Allow users to store or filter data for a variety of purposes Distribution lists tables Store recipient audience records Campaign Supplemental data sources Store miscellaneous data that can be used for a multi-table relational schema in a campaign for message content personalization and individualization. Link tables Store link tracking information. Campaign event tracking log tables Store recipient-level data on how recipients respond to given campaigns. SQL objects Represent a SQL view on a base table. Documents Consist of re-usable creative content in the form of HTML and Text document objects that are available for use in any Campaign or Form. Folder Allow users to manage their various marketing projects by placing application objects in a series of user-defined folders The Interact API provides programmatic control over many of these objects, allowing client application developers to create, change, or remove these objects to accomplish any given marketing automation goal. A brief discussion of these objects is provided below. More information about these objects and their use in Interact Campaign is available via the Interact Campaign documentation and training materials. Interact API Guide Page 20 of 107 Responsys Confidential

21 Campaigns Campaigns Campaign objects define the basic behavior of an campaign in terms of audience, message, and settings. A campaign can be launched in bulk immediately or scheduled for launch. The Campaign object has properties such as: General properties name, description, categorization, etc. Audience distribution list and suppression lists Message from header, reply-to header, subject header, HTML/Text message documents Settings tracking options, auto-close behavior, default variables, campaign event log table, etc. Forms Form objects provide functionality for hosting web forms and processing submitted data. Forms can be used as preference centers or general purpose surveys. Data collected from Forms can be merged into any table. Form responses can also trigger follow-up s to responders. Data Sources Data source objects come in the form of tables, filters, or SQL views and can be used for a variety of purposes in Interact Campaign, including: Distribution Lists Contain recipient records and can be used to define the audience of a campaign. Supplemental Data Contain data that can be joined with a distribution list or queried by dynamic content template functions to personalize and individualize a campaign message. Campaign Event Tracking Log Data Contain recipient event data such as Sent, Opened, Clicked, etc. that are generated by the Interact Campaign platform as recipients are involved in and respond to various campaign messages. Link Tracking Data or Link Tables Contain data needed to track links in a campaign message. At a minimum, columns for a link name and a link destination URL are required for use of a link table in a campaign. An account can have any number of data sources, but it is recommended that a central contact list be created for a given marketing objective. Ideally, a central list is created and updated using registration and preference center web forms and/or daily FTP-based file feeds for situations where the recipient data is managed out side of Interact Campaign. This central list table can then be filtered or queried to generate campaign distribution list segments that drive individual campaign audience targeting. Supplemental data sources are often used to store data that is not oriented around the definition of a list recipient identity, but used instead for supplementing a list with additional recipient profile attributes via a join based on some related key field (called the Data Extraction Key ). Any given table schema is completely user-defined and, as a result, data source tables can be used for a wide variety of uses, ranging from segmentation and message personalization to storing campaign recipient level campaign event records. Interact API Guide Page 21 of 107 Responsys Confidential

22 Documents When several tables are used to represent a multi-table relational marketing database where a variety of queries or joins are made on the tables involved, users should create the proper indexes to prevent unwanted performance impacts associated with full table scans on the tables being queried or joined. Documents Document objects define the creative content that can be used for Campaigns and Forms. There are two subtypes of document object: HTML and Text. Example: An campaign usually consists of an HTML and Text document reference. The campaign will handle the packaging of HTML-only, Text-only, or Multi-part s automatically based on the recipient profile. Documents can be re-used across multiple campaigns and forms as well as copied, edited, and deleted via the Interact Campaign user interface. Interact API Guide Page 22 of 107 Responsys Confidential

23 General Steps Interact API Getting Started To use this guide, you should have a basic familiarity with software development, SOAP-based Web Services and the Interact Campaign user interface. Brief instructions for getting started with the Interact API in a Java or C# application are provided in this section. General Steps In general, any Interact API client application project will involve the following steps. 1. Use the Interact API web services definition language (WSDL) document to generate supporting code for executing SOAP-based client calls on the Interact API. Your development environment tool of choice should provide support for accomplishing this step. 2. Use the Login call to establish a session with the Interact API. The Login call will return a session identifier that should be placed in the SOAP header of all subsequent Interact API calls. 3. Use the available Interact API calls to accomplish a desired integration objective. If your client application is inactive for longer than two hours, the session identifier will become invalid and your client application will need to make a new Login call to start a new session. 4. Use the Logout call to end the Interact API session. For Java Applications 1. Download the WSDL document and name the downloaded file ResponsysWS.wsdl and place it somewhere in your project directory. 2. Use the Apache Axis2 WSDL2Java utility, as described on the Apache Axis2 web site, to generate Web Services API stub classes: %AXIS2_HOME%\bin\WSDL2Java -uri ResponsysWS5.7.wsdl -wv 1.1 -u -d adb -s -p responsys.ws57.client -sp Assuming the following environment variables are defined: AXIS2_HOME = C:\axis2-1.4 (or location of the Apache Axis2 Standard Distribution) AXIS2_LIB = %AXIS2_HOME%\lib AXIS2CLASSPATH = %AXIS2_LIB%\axis.jar;%AXIS2_LIB%\jaxrpc.jar;%AXIS2_LIB%\saaj.jar; %AXIS2_LIB%\commons-logging.jar;%AXIS2_LIB%\commonsdiscovery.jar;%AXIS2_LIB%\wsdl4j.jar 3. In your Java application, make sure that the generated Interact API stub classes are available to your project build path. Interact API Guide Page 23 of 107 Responsys Confidential