Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can build the ability to activate a new MailUp 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. An example of application using the MailUp account provisioning API is the Odin one APS package. Below we describe how to activate a free trial account, but the same methods can be used - upon request - to provide custom setups (ie whitelabel platform with custom features enabled). 

...

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 trial account activation methods: 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 )Register your application to get your API keys. 
  • Contact MailUp Support and ask for enabling your application to use the account provisioning feature. 
  • Your request will be reviewed and, in case of success, your application will be authorized to create new MailUp trial accounts

How to activate a trial account

...

Note

No more than one trial activation is allowed from the same caller IP. In order to facilitate support the development and to avoid the creation of unused accounts, developers can take advantage of the "fake activation" feature, which can be used when IpAddress = 127.0.0.1 or when IpAddress starts with "192.168.". "Fake activation" does not actually create a new account and it returns "-1" as activation request code. In addition, in case of "fake activation", a random value1 is returned when calling TrialActivationStatus

(1) returned values have range that spans from 1 to 7 and they can be used to simulate real cases. Due to an API limitation, also "0 - Not Confirmed" may be returned in case of fake activation, please manage this case exactly as "1 - Confirmed"

...

Important notes

    • Creating a new account may take up to a couple of minutes. 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 that can return those values.
    • Currently there’s no implemented functionality in the MailUp API set way to retrieve the list of the accounts activated consoles from by a certain application. This ability is planned to be implemented in the near future.