API

What is the Mapp Engage API?

An API is used by two or more platforms 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 authorization header must be included in each API request.

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

You should use "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

Clients connecting to the Mapp Engage webservice API should ensure that the their webservice clients correctly add or include the Host header in the HTTP header.

The domain name sent in the HTTP header must be identical to the domain name of the webservice url that you are connecting to.

Our webservices require that the host header value be set as this will be used along and in parallel with the requested url when connecting to our servers.

Without this host header, there could be issues when connecting to the correct service and server, and could also trip our anti-intrusion systems.

e.g : Host: staging11.shortest-route.com