Introduction

The Cloudlink Toolbox allows for the external registration of users with your service. To accomplish this, and maintain the best possible user experience, the Cloudlink Toolbox (which is a native application on the android device) will use the URL provided by you to allow registration of customers. The UI flow is simple, and the user must follow only a couple of rules to work within the Cloudlink Toolbox.

UI Flow

How to Install Apps using Cloudlink

A registered user opens the Cloudlink Toolbox and selects your application install. The install button will say Register until they are registered with your service. After this, the install button will read Install.

The user clicks on the Register button.
The Cloudlink Toolbox will load whatever URL you provide, but append the following three elemements:
- app_id - The Cloudlink Toolbox application identifier, please record this for the session as we'll need it back later.
- name - The name of the customer provided during the Cloudlink registration process. You can use this information to pre-populate fields in your registration form.
- email - The email address of the customer provided during the Cloudlink registration process. You can use this information to pre-populate fields in your registration form.
The URL that is loaded will have full ownership of the view and the Cloudlink Toolbox branding will no longer be displayed.
It is expected that a registration type form will be shown, along with some information text on the application and/or service.
If the user wishes to cancel, the cancel button should call the javascript function: AppStore.cancelRegistration(). This will cause the Cloudlink Toolbox to be reloaded.
If the user successfully registers with your service, they should be presented with a UI that allows them to download the app. The UI will say “Thanks” and have, otherwise, only one control button. The action of that link/button should be a javascript call to AppStore.registrationComplete('«app_id»') using the app we passed in on the original call.
The UI will return to the Cloudlink-branded UI and start downloading the application.
Once the application is installed, the user will be returned to the Cloudlink Toolbox app list view.

Example page

An example html page that contains two links with associated javascript actions looks like:

<html>
  <head>
    <script type="text/javascript">
      function cancelRegistration(){
        AppStore.cancelRegistration();
      }
      function registrationComplete(){
        AppStore.registrationComplete('4fc88a82d78bcd0001000009');
      }
    </script>
    </head>
  <body>
    <div style="margin:10px auto;width:100px">
      <ul style="list-style-type:none">
       <li style="padding:10px 0px"><button onclick="cancelRegistration()">Cancel</button></li>
       <li style="padding:10px 0px"><button onclick="registrationComplete()">Download</button></li>
      </ul>
    </div>
  </body>
</html>