User registration from public demo

When using WHMCS + cPanel or Plesk

1. Log in to WHMCS admin area.
2. Create shared hosting product(s) for Site.pro builder:
   1. Go to "System Settings" → "Products/Services" (for WHMCS 7: "Setup" → "Products/Services" → "Products/Services") in WHMCS admin area.
   2. Create new product for site builder. You can duplicate it from your current shared hosting product (but setup different name, price and other options for them). You can find more about WHMCS shared hosting products on this page: https://docs.whmcs.com/Products_and_Services.
   3. On tab "Module Settings" activate option "Automatically setup the product as soon as an order is placed".
   4. Go to "System Settings" → "Module Addons" (for WHMCS 7: "Setup" → "Module Addons") → button "Configure" next to "Site Builder".
   5. Enter name of newly created shared hosting product into field Applicable Products.
3. Open created shared hosting product for editing again and navigate to tab "Links".
4. Copy the link from field "Direct Shopping Cart Link".
5. On Site.pro licenses page expand your brand and switch to section "Customize builder".
6. Click button next to "Public Demo URL" field to open Demo builder configuration.
7. Activate options "Use Registration form" and "Use Remote Registration form".
8. Into field "Login/register API URL" insert the shared hosting link which you copied, and click "Apply" button to save changes (and "Apply" button of the brand).
9. Done! Open public demo builder URL from your brand, choose template and click button "Publish" to check if it is working properly.

When using custom integration

This documentation describes the implementation of user registration from public demo builder version. The public demo URL is a URL which let's you to enter builder as a guest without login or registration. It creates temporary domain for the guest client and there he can try the builder and build a temporary website. Initially public demo URL is intended for quick builder testing in order to get familiar with its functionality. However often guest clients spend a lot of time inside and during that time they manage to build complete website which they do not want to loose and have it in production. This is where the registration from public demo builder comes to the rescue.
The complete flow of this whole process is intended to be the following:

1. you find the Public Demo URL in your brand on licenses page;
2. you copy that URL and put it somewhere on your hosting website visible place (e.g. it can be a button with a title "Demo" and a link with public demo URL);
3. guest client comes on your page, clicks that button and goes to builder;
4. guest client builds website and presses button "Publish";
5. guest client is presented with a registration form which he fills in and submits;
6. you catch guest client's data on your end and handle registration for him (more about it below);
7. after the registration the client's website is published to a new place and becomes live.

In order to activate this functionality take the following steps:

1. go to licenses page;
2. open your brand and switch to "Customize builder" tab;
3. click button next to "Public Demo URL" field to open Demo builder configuration;
4. activate option "Use Registration form".

Description of options:

• Use Registration form (required) — activates registration from public demo builder.
• Use Login form (optional) — if checked then the login form will also be provided to the guest client where he can login with credentials he used during registration. After logging in his website will be loaded in builder created earlier.
• Use Remote Registration form (optional) — if checked then the user registration will be done not remotely calling your API endpoint (described by "Login/register API URL" field) but by redirecting the guest client in browser by this URL. In this case you need to implement visual registration form for your clients on that page and all registration process will be done on your end.
• Hide Publish sub-menu (optional) — if checked then "Publish" sub-menu will not be shown in public demo builder. It includes buttons "Save draft" and "Backup/Restore".

Description of fields:

• Login/register API URL (required) — there you need to put your API URL which you implement by documentation below. It can be any URL accessible globally, e.g. https://myhostingsite.com/api/register-from-builder/.
• Banner Image URL (optional) — if set then the floating image will be displayed fixed to the bottom of the screen in public demo builder.
• Message to be shown (optional) — if set this message will appear after successful user registration in public demo builder (if not set then default text will be used).

The same API endpoint URL will be used for registration, login and password remind requests, but you only need to implement functionality for parts you selected check-boxes for (above).

<?php
$data = json_decode(file_get_contents('php://input'));

Registration API endpoint

This endpoint will need to handle new user registration in your hosting system.

These options must be checked:
Use Registration form

Request parameters:

• Boolean register – if this is set and equal TRUE then this is new user registration request
• String name – name (friendly name or full name or just general name) of the user to use for registration (this can be ignored if not required)
• String email – user email to use for new user creation
• String password – password to set for new user
• String password2 – repeated password to make sure user entered it correctly
• String ip – IP address of user (this can be ignored if not required)
• String locale – locale code (ex. en_US)

Response parameters (success):

• Boolean ok – this needs to be equal to true to indicate success
• String domain – domain name that was created for this user to identify their site
• String ftpUser – FTP username to be used for publishing website to hosting server
• String ftpPass – FTP password to be used for publishing website to hosting server
• String uploadDir – directory path in FTP server to upload published website
• String ftpHost – IPv4 address of FTP server used for publishing website to hosting server
• String hostingPlan – hosting plan assigned to user

Response parameters (error):

• String error – error message explaining why this failed, that will be shown to user

Login API endpoint

This endpoint will need to handle existing user logins to your hosting system (if you are implementing this you will also need to implement remind/reset password endpoint).

These options must be checked:
Use Registration form Use Login form

Request parameters:

• Boolean login – if this is set and equal to TRUE then this is user login request
• String email – user email to use for logging in
• String password – user password to use for logging in

Response parameters (success):

• Boolean ok – this needs to be equal to true to indicate success
• String domain – domain name that was created for this user to identify their site
• String ftpUser – FTP username to be used for publishing website to hosting server
• String ftpPass – FTP password to be used for publishing website to hosting server
• String uploadDir – directory path in FTP server to upload published website
• String ftpHost – IPv4 address of FTP server used for publishing website to hosting server
• String hostingPlan – hosting plan assigned to user

Response parameters (error):

• String error – error message explaining why this failed, that will be shown to user

Remind/reset password API endpoint

This endpoint will need to handle reminding/resetting password of existing user (basically same thing remind/reset password does in you hosting system) in your hosting system.

These options must be checked:
Use Registration form Use Login form

Request parameters:

• Boolean remind – if this is set and equal to TRUE then this is remind password request
• String email – user email of which password needs to be reminded/reset

Response parameters (success):

• Boolean ok – this needs to be equal to true to indicate success

Response parameters (error):

• String error – error message explaining why this failed, that will be shown to user

Remote Registration endpoint

These options must be checked:
Use Registration form Use Remote Registration form

If you enable remote registration then instead of API call user will be redirected to provided API URL.

User will be redirected using HTTP POST request with content type of application/x-www-form-urlencoded; charset=UTF-8 (general POST data) and it will contain these parameters:

• String locale – locale code of the language user is currently viewing builder in
• String createFrom – current builder demo session ID (this session will be valid up to 24h)

When user completes registration process on your page then he/she needs to be redirected back to builder to complete copying and publishing of his site created in demo version to his/her newly registered website.

Redirection back to builder needs to be performed using Create session API. The only difference from that API is that you will need to set additional parameter "createFrom" to a value that you got POST'ed to your registration URL.