Page Comparison

Problem

Applications that integrate with MailUp may need wish to request new MailUp trial accounts if the user of the application is not yet a MailUp user.

Solution

You can build the ability to activate a new MailUp trial account right into your application by using the MailUp public API endpoint. Below you can find the expected workflow and the technical details for implementing it.

...

...

Workflow

1. The external application requests account activation using TrialActivation method and specifying an email address that has already been confirmed (i.e. there is no need of an additional email that confirms that email address is valid)
2. Activation starts and TrialActivationStatus method can be used to get activation status. When activation is in progress, TrialActivationStatus returns a value that is different than 2. While status is different than 2 the external application is not yet able to connect to the console account, the following strings could be displayed:
   1. Value = 3,4 or 6 => “An error happened, the activation will be managed directly by MailUp support”. This result rarely happened during maintenance activities, in which processing was suspended for about 2 hours and then restarted.
   2. Value = 5 or 7 => ”The trial activation is in progress, you’ll receive the account credential soon.”
3. When activation is completed you’ll receive MailUp account credentials in your inbox and, at the same time,  TrialActivationStatus returns 2.
4. At this point the MailUp account is available and received credentials can be inserted into the external application to perform authentication on the newly activated account

...

Different authentication & authorization

Access to the resources (lists, messages, subscribers) of the newly activated account requires an authentication and authorization process that is different than

...

the one used for the /wiki/spaces/mailupapi/pages/36340648: specifically, it requires OAuth2 authentication with a token that has to be periodically refreshed when HTTP 401 error is returned. Please refer to "Samples and Wrappers" if you need a working example of an application that properly uses refresh token to access to MailUp resources. See more information about /wiki/spaces/mailupapi/pages/36340656.

Getting Started

• Activate a developer console at http://developers.mailup.com/setupen
• Setup a new application from the freshly activated developer console (http://help.mailup.com/display/mailupapi/Getting+started)
• Take contact with Mail Up Support ( support@mailup.com ) to log a request for application authorization. ( please provide a description of the application, its name and related clientID )

How to activate a trial

...

account

• POST callback URL: https://services.mailup.com/API/v1.1/Rest/PublicService.svc/Console/TrialActivation a POST callback must be addressed to, with the following arguments  
• Arguments :
  
  

{
	"Company":"String content",
	"Email":"String content",
	"IpAddress":"String content",
	"IsUSA":true,
	"Language":"String content",
	"NameAndSurname":"String content",
	"PhoneNumber":"String content",
	"Referer":"String content",
	"RegisterToNewsletter":true,
	"UserAgent":"String content"
}

1. 1. Passed in arguments, Arguments can be sent as Xml or Json according to the user defined value set in the header (http://help.mailup.com/display/mailupapi/Resource+access+data+format)
   2. Arguments and their meaning can be explained as follows :

...

...

...

Relevant notes

• • Automated consoles’ activations require a couple of minutes at least to complete. When completed, the activation process will take care of sending activation confirmation message and login credentials to the applicant’s defined email address
  • Login credentials can be only transmitted by email as there’s no API method in charge to.
  • Currently there’s no implemented functionality in the MailUp API set to retrieve the list of activated consoles from a certain application. This ability is planned to be implemented in the near future.

...