Home
API Guides
SOAP API Specification
Using the Unica Campaign SOAP API
To use the Unica Campaign Web Services SOAP API, you can use the client API .jar file or use the WSDL directly. An example shows how to use the .jar file method to create an offer.
Using the client API .jar to call Unica Campaign services
Unica Campaign provides a client API that uses SOAP web services to interact with the Unica Campaign web application. This wrapper is bundled into a .jar file that the client application can use to call the Unica Campaign API.

API Guides
- SOAP API Specification
  - Unica Campaign Rest APIs
  - Unica Campaign Services API Overview
    The Unica Campaign SOAP API specification defines version 3.0 of the Application Programming Interface, also referred to as Unica CampaignServices. This specification is delivered as part of the Unica CampaignServices Software Developer's Tookit (devkits) installed with Unica Campaign.
  - Using the Unica Campaign SOAP API
    To use the Unica Campaign Web Services SOAP API, you can use the client API .jar file or use the WSDL directly. An example shows how to use the .jar file method to create an offer.
    - Using the client API .jar to call Unica Campaign services
      Unica Campaign provides a client API that uses SOAP web services to interact with the Unica Campaign web application. This wrapper is bundled into a .jar file that the client application can use to call the Unica Campaign API.
      - To compile and run this Java™ sample, you must include all dependent .jar files in the Java classpath. The CampaignServicesClient30.jar file depends on Apache AXIS2 SOAP engine .jar files and other common Apache .jar files, which can be found in <CAMPAIGN_HOME>/Campaign.war. Extract the .jar files from Campaign.war, and include them in the Java classpath.
    - Using the WSDL to call Unica Campaign services
      Unica Campaign services can be called by using the Unica Campaign web services WSDL file: CampaignServices30.wsdl.
    - Performance considerations
  - SOAP API data types
    The Unica Campaign Services SOAP API uses the following public data types.
  - SOAP API methods
    The Unica Campaign Services SOAP API uses the following methods.
  - The Unica Campaign SOAP API may throw the following common exceptions. All exception localized messages are in the requested locale if available to Unica Campaign. The usual Java™ locale fallback policies apply.
- REST API Guide
  Use the Unica Campaign REST API to manipulate campaigns, offers, offer lists, attributes, and target cell objects.

Using the client API .jar to call Unica Campaign services

Unica Campaign provides a client API that uses SOAP web services to interact with the Unica Campaign web application. This wrapper is bundled into a .jar file that the client application can use to call the Unica Campaign API.

The .jar file can be found at:

<CAMPAIGN_HOME>/devkits/CampaignServicesAPI/lib/ CampaignServicesClient30.jar

The following example shows new offer creation at the root Offer folder level in Unica Campaign. The same sample can be found at:

<CAMPAIGN_HOME>/devkits/CampaignServicesAPI/samples/OfferAPI.java

Note: The example uses some dummy values for the parameters; your actual values might differ.

Also, the URL for Unica Campaign web services is http://host:port/Campaign/services/CampaignServices30Service, where host and port refer to the host name and port number of the machine where the Unica Campaign web application is deployed.

If you use a provided sample, be sure to modify it to suit your client environment.

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.