Info | ||
---|---|---|
| ||
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 to share information
without the need for human intervention.
The Mapp Engage API makes it possible for you to connect any program
to your marketing platform
This lets you pull data into our system and extract information for reuse in other applications
.
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-headere.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
v19.
Tools
SoapUI is an open-source web service testing tool
Download and install soapui
To setup REST project
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
Other tools
so called response queue | ||
Contains methods |
methods to manage messages stored |
in the |
CMS |
methods to manage elements in the Content Store. | ||
Contains methods for working with |
message |
saved as a draft. | ||
Contains all group-related methods. | ||
Contains |
methods to manage landing pages. | ||
Contains |
to manage approx properties | ||
A prepared message is a saved message |
to interact with a process in Mapp Engage. | ||
Contains methods to manage records stored in Related Data. | ||
Contains |
methods about the current version of the system |
. | ||
Contains system user-related |
to system user. | |
usagestatistics |