Loading...
Area: Episerver Campaign
Applies to versions: Not applicable

Introduction

Recommendations [hide]

The following documentation describes the HTTP mail service and form service for Episerver Campaign.

Application possibilities

The email marketing solution Episerver Campaign cannot only be used with the graphical user interface (GUI). With the help of an HTTP interface, frequently used functions can be integrated into your own website. In addition, functions can be performed by email.

The HTTP API provides a simple method to integrate Episerver Campaign in your website. To perform functions, you simply call a URL and pass some parameters.

Additionally, the HTTP API provides special URLs to add data to recipient profiles by using emails.

The HTTP API provides the following features:

  • All functions are executed using a simple HTTP request (GET or POST).
  • All functions are stateless, i.e. one request has one response.
  • Using the HTTP API no data can be retrieved. New data can only be sent.

The following examples show you the possibilities and limitations of the HTTP API. The HTTP API is suitable for:

  • Integration of subscribe/unsubscribe forms on your website to Episerver Campaign
  • Adding data to a recipient profile by email

The HTTP API is inappropriate or only suitable with certain restrictions for:

  • Profile change forms that directly access the Episerver Campaign database.
  • Recommendation forms that directly access the Episerver Campaign database.

Restrictions

Existing data stored in the Episerver Campaign database cannot be retrieved using the HTTP API. However, to change a recipients profile, it is absolutely necessary to retrieve data. To implement this function using the HTTP API, the recipient data must be kept in your own database. Changes are made in this database. Before a mailing is sent, the data must be copied from your database to the Episerver Campaign database. This can be done with the HTTP API.

For the latter functionalities, we recommend to use the REST API. This convenient interface offers almost unlimited possibilities to connect Episerver Campaign to your website.

Information regarding general use

If you wish to restrict the requests of the HTTP API to the services and operations needed for your purposes, contact customer support and tell us which services and operations you want to use.

For every HTTP API request from the form service, Episerver sets up an IP address or IP address range from which the interface can be accessed. This setting reduces the risk of unauthorized access through the HTTP API. Tell us the IP address or IP address range you want to allow.

Tip: You can as well restrict the access to the API server by using a firewall. If you wish to do so, we recommend to use DNS-based filter rules or the subnet 193.169.180.0/23.

Before starting the implementation of the HTTP API on your system, read the following carefully: The correct functionality of the HTTP API interface can only be guaranteed if the automatically sent exceptions and return values are continuously analysed by your IT department and necessary adjustments resulting from these are carried out on your system and/or website. Give us a contact person we can inform about extensions, updates and troubleshooting. The following data are required:

  • First name
  • Last name
  • Email address
  • Telephone number
Do you find this information helpful? Please log in to provide feedback.

Last updated: Apr 25, 2018

Recommendations [hide]