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.
Performance considerations

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.
    - 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.

Performance considerations

The current CampaignServices API implementation performance profile is similar to that of the application as experienced through the GUI. Some APIs are designed explicitly for performance. In particular, the listCampaignsByPage() API allows for relatively efficient pagination.

The SOAP interface, by its nature, introduces latency and overhead because all data is converted into XML form, which in some cases is fairly verbose. For example, a simple loopback SOAP call can take 100 ms on a typical network (Java™ 1.4.x was even slower). The API is optimized for typical portal and other client application business use cases, such as see listOffersByPage(), so SOAP performance should be adequate.

However, the client must take care that it does not place too high a burden on normal CampaignServices servicing of Web user requests. In general, it is expected that an API user's processing needs do not exceed those of a typical Unica Campaign web user.

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.