Home
Administrator Guides
Startup and Administrator Guide
Unica Deliver REST APIs
Deliver has exposed REST APIs which can be used to perform variety of operations like working with Email, SMS, Push, WhatsApp messages and communication templates, working with batch production and test message sending as well as transactional message sending. This chapter provides details of these APIs, how to authenticate and generate API token which is needed to call these APIs.
Generating an authentication token
Before using any API, generate an authentication token using login API as mentioned in the following menthod:

Administrator Guides
- Startup and Administrator Guide
  - Hosted messaging using Campaign and Deliver
    When Unica Campaign is integrated with Unica Deliver, you can use Deliver to conduct highly personalized digital marketing campaigns.
  - Configuring the local HCL Unica environment for Deliver
  - Connecting to hosted email services
    To access message services provided by Unica, you must configure a connection between the local HCL Unica installation and HCL Unica hosted services.
  - Working with the Response and Contact Tracker
    The Response and Contact Tracker (RCT) is installed in your local environment and communicates with HCL Unica hosted services to retrieve and process data for email contacts, email delivery, and recipient responses, such as link clicks and opens. The RCT must be running in order to retrieve link tracking and email delivery notification data from HCL Unica hosted services .
  - Testing the Deliver installation
    To ensure access to all hosted email features, test the configurations and connections for your Campaign and Deliver installations after you enable Deliver, expand your Deliver installation, or upgrade the Campaign installation.
  - Unica Deliver REST APIs
    Deliver has exposed REST APIs which can be used to perform variety of operations like working with Email, SMS, Push, WhatsApp messages and communication templates, working with batch production and test message sending as well as transactional message sending. This chapter provides details of these APIs, how to authenticate and generate API token which is needed to call these APIs.
    - Generating an authentication token
      Before using any API, generate an authentication token using login API as mentioned in the following menthod:
    - Working with Unica Deliver REST APIs
      Once you have obtained an authentication token, you can invoke APIs by passing that token as part of authentication header and rest of the parameters as needed for each API.
  - Configurations for Unica Deliver
    The Unica Platform provides various configuration properties to modify the behavior and appearance of Deliver. Some configuration properties are set during installation. You can change configuration properties at any time.
  - Utilities for Deliver
    Deliver provides several scripts that you use to administer Deliver functions.
  - About troubleshooting Deliver
    Unica Deliver provides various tools and techniques that you can use to investigate issues related to your Campaign and Deliver installations.
  - Managing user access to mailing features
    Campaign and Deliver use roles and permissions provided by the Unica Platform to control user access to messaging features in Deliver and Campaign. You must have permissions in Unica Platform and Campaign to make the required changes. You must also be familiar with how to configure roles and permissions in the Platform and how to define security policies for Campaign.
  - Technote (troubleshooting)
  - Deliver channel vendor account configuration
- Transactional Message Administrator Guide

Generating an authentication token

Before using any API, generate an authentication token using login API as mentioned in the following menthod:

POST https://<deliver_host>/deliverui/api/deliver/rest/v1/login

Request Header:

m_user_name: {deliver_account_user_name}
m_user_password: {deliver_account_password}

Response:

The earlier mentioned API will return a token which should be used in subsequent APIs.

Example: A CURL request for login API for Unica Deliver US datacenter:

curl --location --request POST 'https://em.unicadeliver.com/deliverui/api/deliver/rest/v1/login' \
--header 'm_user_name: <USER>' \
--header 'm_user_password: <PASSWORD>'

If the username and password combination is valid, it returns a 200 OK response with payload similar to the following example:

{
    "m_tokenId": "1661234885892-69-zQEqQ6n5-XmV3-W3PhU3p4-eOQ7-0ohb1tKA",
    "createDate": "Tue Aug 23 06:08:05 UTC 2022",
    "m_user_name": "a38test"
}

This token is typically valid for 30 minutes.

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box.