The Emarsys API provides programmatic access to the large parts of the functionality Emarsys Marketing Platform.
- What is the Emarsys API?
- How do I get started?
- Which UI features does the API support?
- Glossary of terms
- The list of available endpoints can be found here.
The API demo page
- Emarsys provides a demo page where you can experiment with the API capabilities. This has a graphical user interface allowing experimentation with API requests and their parameters. The responses are then displayed so you can see what to expect.
- The list of possible error codes and their explanation can be found in the Appendix.
What is the Emarsys API?
The Emarsys API provides programmatic access to the Emarsys Marketing Platform. It provides value in two areas: integration and automation.
- Integration means accessing the power and functionality of the Emarsys platform directly from within your own application.
- Automation means setting up complex eMarketing campaigns that run without the need for any human interaction on your side.
An integration does require effort and commitment from your side to set up. But this is a one-time investment: after you have set up your automated workflows you can create and launch email campaigns, update contact data, import and export contact lists, all at the touch of a button and without having to log in to another application. The greater your initial effort, the faster you will reap the benefits in hours saved.
How do I get started?
The Emarsys API is available in the api.emarsys.net domain. For each API request, you need your
secret for the API. Ask your Account Owner to create these for you. For more information, see: Security Settings.
If you have already connected successfully to the API, you might want to move straight to the Use Cases, where we show a number of typical scenarios that can be automated via the API.
Which UI features does the API support?
The main purpose of the API is to automate frequently used operations, not to replicate the full set of UI features. If you have any specific queries, our Technical Support teams are happy to help with advice and support. The Emarsys API provides a lot of functionality, but most of our customers use it in the following main areas:
The Emarsys API offers a wide range of functions for creating, retrieving, updating and deleting contacts, which can be used to perform ad hoc actions or set up an automated synchronization process.
Pass content for use in email campaigns without having to log in to Emarsys. The API lets you create and save HTML content for emails as well as include files retrieved from the Media Database.
Once the content for an email has been finalized, use the API to launch, schedule and test email campaigns.
Data export and reporting
Keep track of all new contact registrations and follow the response rates for individual campaigns and contacts. These can then be used in an external tool to cross-reference with other statistics, for example web analytics.
Sending transactional messages
Send transactional (real-time) messages by triggering external events associated with an email.
Using the Automation Center
Alternatively, you can also set up Automation Center programs with entry points that are triggered by API calls. A number of different API calls can be used, depending on the desired workflow, e.g. New Contact, Data Change, External Event, etc.
When using the API to launch emails created in the Emarsys application, all links in the HTML and text sources are still automatically tracked. There is no need for an explicit API call for this. Furthermore, you can define the name of the link and its category as special attributes of the HTML tag.
Glossary of terms
API stands for Application Programming Interface, which is a standard method that software programs use to communicate with each other. It allows programmers to take advantage of other programs’ capabilities. APIs can also be used to automate complex tasks, thus streamlining your workflows.The Emarsys API can be used with any programming language which supports HTTP.
REpresentational State Transfer (REST) is the name of a software architecture for large and distributed systems composed of web services. The World Wide Web’s architecture is one example of a system that conforms to the REST constraints, therefore it can be called “RESTful”.
The Emarsys API is also built using such a REST-style architecture, a simpler and faster approach than its SOAP alternative. It communicates via HTTP requests and uses JSON as its content type and X-WSSE for authentication. Please note that not all data elements are RESTful.
The real REST resources are:
Marketing terminology used by Emarsys
Here you can find a list of the terms that we use in the Emarsys application interface and in the supporting documentation.