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

REST API

Using the REST API in Episerver Campaign, you can perform an HTTPS request to control the following functions remotely:

Set up the REST API in your client

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

Note: For setting up the REST API, 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, Episerver customer support will set up your API user.
In contrast to Campaign standard users, API users only have access to services and methods needed for API purposes. This is due to security reasons.

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. A free online encoder is available here.

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.

Swagger API REST documentation

For a description of the methods and resources, see the Swagger documentation here.

Last updated: Jun 12, 2019