Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Problem

Platforms provided with MailUp integration connector should be also put in the condition to run console trials activation for those individuals yet to subscribe to Mailup.

Solution

It is possible to build an application with the ability to activate a new trial console via public API endpoint. This is the complete operation list :

Introductory operations

How to activate a trial console

{
	"Company":"String content",
	"Email":"String content",
	"IsUSA":true,
	"Language":"String content",
	"NameAndSurname":"String content",
	"PhoneNumber":"String content",
	"RegisterToNewsletter":true
}
    1. Passed in 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 are all mandatory and their meaning can be explained as follows :
      1. Company = Business Name
      2. Email = Email address who will be sent of the confirmation request and access information
      3. IsUSA = Cost centre, put False for activations from the Euro zone, else put True.
      4. Language = console language, please use one of the following : EN, ES or IT ( English, Spanish or Italian)
      5. NameAndSurname = Applicant first and family names
      6. PhoneNumber = Applicant phone number
      7. RegisterToNewsletter = True if the applicant is intended to receive Mailup Newsletters

  • 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:

    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 thi 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 thi 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 callback to TrialActivation  and further callbacks looping on TrialActivationStatus until it returns ID=2

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.
  • Al momento non è prevista una funzione per interrogare le API di MailUp ed ottenere l'elenco delle console attivate da una certa applicazione, questa funzione è comunque inserita tra le probabili estensioni future
  • Currently there’s no implemented functionality in the MailUp API set to retieve the list of activated consoles from a certain application. This ability is planned to be implemented in the near future.


  • No labels