Page tree
Skip to end of metadata
Go to start of metadata

DEPRECATED


 

Endpoints

SOAP: http://services.mailupnet.it/1.0/MailUpService.svc

REST: http://services.mailupnet.it/1.0/MailUpService.svc/rest

 

Methods

CategoryDescriptionAvailable methods
AuthenticationLogin and logout methods.
Login returns an access key that can be used as parameter when calling other methods
FiltersCreate and delete MailUp filters.
TestThis group includes methods that can be used to test the service
  • Ping

 

Using SOAP

As specified in WSDL, SOAP methods receives a specific "request" object as input parameter and return a specific "response" object. Please refer to the description of each method for more details.

Error Handling

In case of error a standard SOAP Fault object is returned (more on this)

Using REST

REST is supported only when XML parameters are passed with http POST method (Ping method is the only exception, which can be called using http GET http://services.mailupnet.it/1.0/MailUpService.svc/rest/Ping).
Required parameter format is the same as what is specified for SOAP requests (see example below).

Restrictions
  1. Available REST methods cannot be called using HTTP GET ("Ping" test method is the only exception, which can be called using http GET http://services.mailupnet.it/1.0/MailUpService.svc/rest/Ping)
  2. JSON is not supported

Any client implementation that performs authentication to MailUp API using REST from a client-side script (e.g. by calling AuthenticationLogin from a Javascript page) may expose your credentials to hacking.
MailUp is not responsible of data leaks due to external client applications that do not apply suitable security policies.

 

Configuration

Please refer to REST configuration page to get some tips about enabling REST

Example

Call http://services.mailupnet.it/1.0/MailUpService.svc/rest/AuthenticationLogin passing the following XML as parameter in HTTP POST:

AuthenticationLogin with REST (Request)
<LoginRequest>
	<Username>xxxx</Username>
	<Password>yyyy</Password>
	<IdConsole>10001</IdConsole>
</LoginRequest>

A successful response has this format:

AuthenticationLogin using REST (Response)
<LoginResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Token>A973Amr5FJZzsZukgfdBkjblveNL8TKnqc5iLjDyixLDF9VdTx0M9N9z4Hiw=</Token>
</LoginResponse>

while "HTTP 400 Bad Request" is returned in case of unsuccessful response

 

More details

  • No labels