Versions Compared

Old Version 3

changes.mady.by.user MailUp Dev Team

Saved on

compared with

New Version 4

changes.mady.by.user MailUp Dev Team

Saved on

Key

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

...

It is possible to build an application with the ability to activate a new trial console via public API endpoint. Here below you can find the expected workflow and the technical details for implementing it:

 

Panel
titleWorkflow
  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

...

    1. in progress, you’ll receive the account credential soon.”
  2. When activation is completed you’ll receive MailUp account credentials in your inbox and, at the same time,  TrialActivationStatus returns 2.
  3. At this point the MailUp account is available and received credentials can be inserted into Drupal to perform authentication on the newly activated account

 

Getting Started

...

    • Method callback must be enclosing the API KEY in the header as stated in this page http://help.mailup.com/pages/viewpage.action?pageId=22806545(Please see Resource Access Requirements)
      [Authorization] = "Basic " + Base64(ClientId + ":" + ClientSecret)
    • Callback response returns an Identity (ID) that can be used to track activation status with a further callback to the following https://services.mailup.com/API/v1.1/Rest/PublicService.svc/Console/TrialActivationStatus. (TrialActivationStatus)

    • Returned codes from TrialActivationStatus are:

      Code Block
      1 – Confirmed (Request has been accepted, activation is ready to start)
2 – Processed (Your trial has been activated and you’ll receive the account credentials in your inbox)
3 – Error (An error occurred and an alert has been notified to our support team in order to solve thithis issue) 
4 – Manual (MailUp platform is in maintenance mode, your request will be processed as soon as the platform will be restored)
5 – In progress (The trial activation is in progress, soon you’ll receive the account credentials)
6 – Blocked (An error occurred and an alert has been notified to our support team in order to solve thithis issue) 
7 – Re elaborated (The trial activation is in progress, soon you’ll receive the account credentials)
    • Any activation request can be performed with a single call to TrialActivation  and further callbacks looping on TrialActivationStatus until it returns ID=2


Note

No more than one trial activation is allowed from the same caller IP. In order to facilitate 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 just returns an "-1" as activation request code.

 

...