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

REST API

The REST API is a convenient alternative to the SOAP API that lets you manage and control Episerver Campaign features from external systems by using HTTPS requests. In contrast to the SOAP API, you can also manage Smart Campaigns.

In total, Episerver provides more than 200 operations in over 16 different web services for this purpose. You can retrieve data from and send data to Episerver Campaign via REST API. REST supports several languages and formats such as HTTPS, JSON, URL and XML.

Using the REST API in Episerver Campaign, you can control the functions listed below remotely. For an overwiew of all resources and operations, see the Swagger REST API documentation.

Setting up the REST API in your client

To set up the REST API in your client, contact customer support.

Provide a separate email address that you do not yet use for Episerver Campaign. This address must use the same domain as your Campaign user login and should not be personalized, for example api-user@company.com.

You should also have access to the inbox of this address, as Episerver will send an activation mail. Using that email address, customer support will set up your API user.

Note: Do not log in to the Episerver Campaign front end by using your API user credentials. API users only have access to services and operations needed for API purposes.

Data transmission/representation

The REST API only accepts HTTPS requests. The response data is transferred as a JSON string.

Authentication

The authentication is done via basic authentication with the API user and API password that customer support has set up for you.

To use the Try it out feature in Swagger, click Authorize and enter Basic User:Password in the value field.
Basic is part of the authentication; User:Password must be Base64 encoded.

Basic authentication in Swagger

Date format

Specify data in the ISO-8601 format: YYYY-MM-DDTHH: MM: SSZ

Examples:

2018-05-25T18: 08: 55 + 02: 00
2018-05-25T20: 08: 55Z

Finding IDs

After customer support has set up an API client, you can find the client ID under start menu > Administration > API overview > SOAP API.

Campaign ID, mailing ID, confirmation ID etc. are documented in the corresponding list in Campaign.

Do you find this information helpful? Please log in to provide feedback.

Last updated: Nov 11, 2019