Page History

Info

title	IMPORTANT

please note this documentation is no longer being updated. for the most up to date information, please visit Engage API

What is the Mapp Engage API?

An API is

used by two or more platforms

used to share information

and manage processes

without the need for human intervention.
The Mapp Engage API makes it possible for you to connect any program

or webpage

to your marketing platform

.
This lets you pull data into our system and extract information for reuse in other applications

.

We employ a consistent scheme for our SOAP and REST API solutions. Feel free to decide which solution best fits your needs.

For an overview of the SOAP solution, see SOAP API. For an overview of the REST solution, see REST

API.Other

API

solutions and the previous REST and SOAP solutions are still available, however, these will no longer be extended or updated

.

If you wish to continue using an old application that is based on these interfaces, please contact your customer support representative.

Authorization & Permissions

Both SOAP and REST API use HTTP basic authentication method
that does not require cookies or session tokens.

For this reason, there are no explicit login and logout methods.
Instead, the authorization header must be included in each API request.

The example header for 'test@test.com' user and 'test' password is following

Code Block
Authorization: Basic dGVzdEB0ZXN0LmNvbTp0ZXN0

You should use the "API user" or "Hybrid User" user type for authentication

.To execute the API call successfully,
the API user account must also have required system permissions

.

Host header

Some systems might require host-header

e.g :

Code Block
Host: staging11.shortest-route.com

Versioning

Contact Mapp Technical Support to confirm if you have the latest version.
At the moment this is

v10

v19.

Tools

SoapUI is an open-source web service testing tool

Download and install soapui

To setup REST project

Download

Download Example REST project

To setup SOAP project

Download Example SOAP project

To setup Control XML project

Download Example Control XML project

To setup SOAP 1.0 (deprecated)

Download Example SOAP 1.0

Start testing

Import project into SOAPUI
Add user and password as on the picture
Image Modified

Other tools

Postman

Domains

API calls are grouped within functional test domains.

REST	SOAP	Description
async	async	Contains methods for

processing data asynchronously and for requesting the result of the process.

so called response queue
automation	automation	Contains methods

that let you interact with automation

for automations in Mapp Engage.
blacklist	blacklist	Contains

methods that you use

methods to manage system and group blacklists.
cms	cms	Contains

methods that you use

methods to manage messages stored

in

in the

Content Management System (

CMS

)

.
contact	contact	Contains methods for contact management.
user	user	Contains more methods for contact management.
content	content	Contains

methods that are used

methods to manage elements in the Content Store.
draftmessage	draftmessage	Contains methods for working with

an email or SMS

message

that has been

saved as a draft.
group	group	Contains all group-related methods.
landingpage	landingpage	Contains

methods that can be used

methods to manage landing pages.
membership	membership	Contains

methods that are used

methods to manage group memberships.
message	message	Contains methods

that can be used

to manage email and SMS messages.
meta	meta	Contains methods that define your system.
mobile	n/a	The mobile domain contains methods

that can be used

to manage approx properties
preparedmessage	preparedmessage	A prepared message is a saved message

that you have

assigned to a group.
process	process	Contains methods

that let you

to interact with a process in Mapp Engage.
relatedData	relateddata	Contains methods to manage records stored in Related Data.
system	system	Contains

methods that return information

methods about the current version of the system

in use

.
systemuser	systemuser	Contains system user-related

methods such as editing, deleting, and creating a

to system user.
usagestatistics	usagestatistics

Image Removed

Page tree

Versions Compared

Old Version 5

New Version Current

Key