Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
<meta name="keywords" content="client profile viewer for whmcs, client profile viewer configuration, whmcs client profile viewer management, whmcs client profile viewer installation, whmcs client profile viewer common problems, about whmcs client profile viewer, whmcs client profile viewer documentation, whmcs client profile viewer faq, whmcs client profile viewer help, whmcs client profile viewer guide, whmcs client profile viewer wiki, whmcs client profile viewer tutorial, whmcs client profile viewer tips, whmcs client profile viewer wiki"></meta>
+
<meta name="keywords" content="godaddy domain registrar for blesta, godaddy domain registrar configuration, godaddy domain registrar management, godaddy domain registrar installation, godaddy domain registrar guide, modulesgarden godaddy domain registrar, godaddy domain registrar wiki,godaddy domain registrar tutorial, godaddy domain registrar tips, godaddy module wiki, godaddy domain registrar common problems, about godaddy domain registrar, godaddy domain registrar documentation, godaddy domain registrars faq, godaddy domain registrar help"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Client Profile Viewer For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The GoDaddy Domain Registrar For Blesta Module."></meta>
  
 
+
=About [http://www.modulesgarden.com/products/whmcs/godaddy_domain_registrar_blesta/features Godaddy Domain Registrar For Blesta]=
 
+
=About [https://www.modulesgarden.com/products/whmcs/client-profile-viewer Client Profile Viewer For WHMCS]=
+
 
{|
 
{|
|style="padding: 10px 0px 10px 0px;"|'''Client Profile Viewer For WHMCS''' is a module which was created to gather all the key information about each of your clients in one simple tooltip.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Godaddy Domain Registrar For Blesta''' enables registration of GoDaddy domains in your Blesta system.<br />
Contact details, purchased products and services, income – all of these and many more organized in convenient widgets will be displayed each time you hover over a client's name.<br />
+
Your clients will be able to order and manage their domains directly in your Blesta client area.<br />
The module enables you to not only conveniently preview the information about each customer but also modify it according to your needs.
+
The module is an excellent tool for every GoDaddy API Reseller who works with Blesta platform.
 
|}
 
|}
<!-- fixed -->
+
 
*'''Addon Module Features:'''
+
<!--fix dla features-->
 +
*'''Client Area Features:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ View The Widgets With Details Of Clients In A Tooltip On Mouseover
+
|style="padding: 10px 0px 0px 30px;"|✔ Access Shopper ID And Password
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Drag & Drop Configuration Of Each Widget Displayed In The Tooltip
+
|style="padding: 0px 0px 0px 30px;"|✔ Log In To Shopper Panel
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Access Various Parts Of System On Click
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Registrar Lock
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Configure Admin Roles Assigned To Each Configuration
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle EPP Code Visibility
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define The Manner In Which The Tooltip Disappears
+
|style="padding: 0px 0px 10px 30px;"|✔ Update Contact Details
 
|}
 
|}
 +
*'''Admin Area Features:'''
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Define The Delay For Showing The Tooltip
+
|style="padding: 10px 0px 0px 30px;"|✔ Register/Transfer/Renew/Cancel Domain
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 30px;"|✔ Automatically Flag Client Tickets To Assigned Admin
+
|style="padding: 0px 0px 0px 30px;"|✔ Update Nameservers
 
|}
 
|}
*'''Widgets:'''
 
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Income
+
|style="padding: 0px 0px 0px 30px;"|✔ Access Shopper ID And Password
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Tickets
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Registrar Lock
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle EPP Code Visibility
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes
+
|style="padding: 0px 0px 10px 30px;"|✔ Update Contact Details
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Notes
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Person Assigned
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Log In As Client
+
|}
+
{|
+
|style="padding: 0px 0px 10px 30px;"|✔ Send SMS - Integrated With SMS Center For WHMCS [http://www.modulesgarden.com/products/whmcs/sms_center/features (read more)]
+
|}
+
*'''Widgets Configuration:'''
+
{|
+
|style="padding: 10px 0px 0px 30px;"|✔ Income:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define The Range Of Income Statistic
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Tickets:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Which Statuses Of Tickets Are Counted
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define If Product/Domain Status Is Shown
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Which Additional Links Are Shown
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define How Much Of A Note Should Be Shown In The Main Tooltip
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Notes For All, Group Notes And My Notes
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define The Length Of Notes Displayed In The Main Tooltip
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define The Limits Of Notes Displayed In The Main Tooltip Per Group
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define The Limits Of Notes Per Group
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Show Client Status Before Their Name
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Color Client Name
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
+
|}
+
{|
+
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs:
+
|}
+
{|
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
+
|}
+
{|
+
|style="padding: 0px 0px 10px 45px;"|✔ Define Amount Of Columns To Display Tabs
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports 301 Different TLDs & gTLDs
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports Blesta 3.6.2
 
|}
 
|}
  
=Installation=
+
=Installation and Configuration=
 
{|
 
{|
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Client Profile Viewer For WHMCS.''' <br/>
+
|style="padding: 10px 0px 30px 0px;"|'''In this brief tutorial we will show you how to successfully install and set up GoDaddy Domain Registrar For Blesta.'''<br />
We will guide you step by step through the whole installation and configuration process.  
+
We will guide you step by step through the whole installation process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|style="padding: 10px 0px 15px 15px;"|'''1. In the beginning make sure that you are the [https://www.godaddy.com/help/what-is-an-api-reseller-plan-5939 GoDaddy API Reseller] and your API User account is active.'''<br/>
 +
''Info: Please note that GoDaddy API Reseller and GoDaddy Reseller are not the same! Our module can be successfully used only with the former account.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''2. Log in to your client area and download GoDaddy Domain Registrar For Blesta.'''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_1.png]]
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_2.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''3. Upload and extract the module into the main Blesta directory.'''<br/>
 +
Files in your Blesta directory should look like this.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_2.png]]
The content of PHP version files should look like this.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:dfterr.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install GoDaddy Domain Registrar for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
 +
File is located in '' 'components/modules/go_daddy/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Client Profile Viewer For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_3.png]]
File is located in '' 'modules/addons/clientsprofiler/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_3.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''<br/>
 +
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products'.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file ''.'''<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_4.png]]
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products' ''.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_4.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br/>
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Client Profile Viewer' '' and press '' 'Activate' '' button.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_5.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes' ''.
+
|}
+
{|
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_6.png]]
+
|}
+
{|
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Client Profile Viewer For WHMCS!'''<br/>
+
You can access your module under '' 'Addons' '' → '' 'Client Profile Viewer' ''.
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_7.png]]
+
 
|}
 
|}
  
=Configuration and Management=
 
{|
 
|style="padding: 10px 0px 30px 15px;"|'''Client Profile Viewer For WHMCS is a module which allows you to quickly display clients' details across the WHMCS.<br/>
 
Additionally, you can easily configure access to the clients' information depending on the admin role.
 
|}
 
 
==Configuration==
 
==Configuration==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can manage tooltip configurations as well as add new ones.<br/>
+
|style="padding: 10px 0px 10px 0px;"|'''Before you can go one, you must generate your GoDaddy API Key and API Secret. You will need them to activate your registrar module.'''<br/>
Each configuration can have multiple admin roles assigned while one admin role can be assigned to a single configuration only.<br/>
+
Underneath you will find instructions where to find your API details.
As you can see on the following screen, you can view the list of enabled widgets and assigned admin roles of each configuration.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_8.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''6. Firstly, log into your GoDaddy account and enter site: https://developer.godaddy.com/'''<br/>
 +
Find '' 'Keys' '' section.
 
|}
 
|}
===Add Configuration===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|To add a new configuration, press '' 'Add New Configuration' '' button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_5.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_9.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''7. You will be moved to a section where keys can be generated and then managed. Please find '' 'Production' '' keys.'''<br/> It should be seen at the bottom of the page, under '' 'Test' '' keys.<br/>Press '+' to generate a new key.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|Afterwards, fill in '' 'Configuration Name'.''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_6.png]]
Add admin roles through choosing each of them from a dropdown menu and pressing '' 'Add'.''<br/>
+
Additionally, select widgets in the configuration the same way you have added admin roles.  
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_10.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''8. Keep your API Key and Secret in a safe place, you will need them in a moment. Note that it is not possible to vie '' 'API Secret' '' again!<br/>
 +
Press '' 'OK' '' to finish.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|If you wish to change the order in which widgets are displayed, simply drag widget to a desired location and drop it.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_7.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_11.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''9. Now, log in to your Blesta and proceed to '' 'Settings' '' → '' 'Modules' '' → '' 'Available'. '' '''<br/>
 +
Find '' 'GoDaddy Domain Registrar' '' and press '' 'Install' '' next to it.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 15px;"|Press '' 'Create' '' to confirm creation of the configuration.
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_7_1.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_12.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''10. Afterwards, press '' 'Manage' '' to configure your API connection.
 
|}
 
|}
 
===Advanced Configuration===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Some of the widgets may have additional configuration, more information about them can be found in this subsection.
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_8.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Client Admin Notes'''
+
|style="padding: 0px 0px 15px 15px;"|'''11. Enter your live API '' 'API Key', 'API Secret' '' and a URL to domain management site.<br/>
*'' 'First Letters' '' - defines the amount of letters of a note shown in the main tooltip. All notes are available after pressing '' '+' '' button.
+
Press '' 'Save Changes' '' when ready.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_9.png]]
 
|}
 
|}
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Client Custom Notes'''
 
*'' 'My Notes' '' - shows '' 'My Notes' '' in the main tooltip.
 
*'' 'Group Notes' '' - displays notes visible for my admin role in the main tooltip.
 
*'' 'Notes For All' '' - if checked, global notes will be visible in the main tooltip.<br /><br />
 
  
*'' 'My Notes Limit' '' - defines limit for notes added to '' 'My Notes' '' group.
+
=Management=
*'' 'Group Notes Limit' '' - defines limit for notes added to '' 'Group Notes' '' group.
+
*'' 'Notes For All Limit' '' - defines limit for notes added to '' 'Notes For All' '' group.<br /><br />
+
 
+
*'' 'My Notes View Limit' '' - defines amount of '' 'My Notes' '' shown in the main widget.
+
*'' 'Group Notes View Limit' '' - defines amount of '' 'Group Notes' '' shown in the main widget.
+
*'' 'Notes For All View Limit' '' - defines amount of '' 'Notes For All' '' shown in the main widget.<br /><br />
+
 
+
*'' 'Notes View Length Limit' '' - defines length of notes, from each group, shown in the main widget.
+
|}
+
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13_1.png]]
+
|style="padding: 10px 0px 30px 15px;"|'''GoDaddy Domain Registrar allows you to offer GoDaddy TLDs through the Blesta system to your customers.'''<br/>
 +
In this short guide we will present you the possibilities of our module.  
 
|}
 
|}
 +
==Packages==
 +
===New Package===
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Client Custom Status'''
+
|style="padding: 10px 0px 15px 15px;"|Before you can offer new TLD for sale you must create some packages with selected TLDs and pricing.<br/>
*'' 'Inline' '' -  if checked, status is displayed before client's name.
+
Go to '' 'Packages' 'Browse' '' and press '' 'Create Package'.''
*'' 'Color' '' -  if checked, client's first and last name are displayed using selected status color.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_10.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Income'''
+
|style="padding: 0px 0px 15px 15px;"|You will see an extensive form. Start with naming your package, select module - '' 'GoDaddy Domain Registrar' '' and activate it now.<br/>
*'' 'Range' '' -  enables you to define a time period for invoices taken into consideration.
+
''Surely you can activate it later on.''
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_11.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Services Amount'''
+
|style="padding: 0px 0px 15px 15px;"|Next, you have to configure your module options.<br/>
*'' 'Product Status' '' - shows product's status
+
*select type: '' 'Domain Registration' ''
*'' 'Domain Status' '' - shows domain's status
+
*Select TLD you wish to allow for sale in this package
*'' 'Product Domain' '' - shows domain of a product<br /><br />
+
*provide default nameservers - they can be changed later on.
 
+
*'' 'Product Domain WWW' '' - shows product's domain www link
+
*'' 'Product WHOIS' '' - shows product's domain whois link
+
*'' 'Product IntoDNS' '' - shows product's domain intoDNS link<br /><br />
+
 
+
*'' 'Domain WWW' '' - shows domain www link
+
*'' 'Domain WHOIS' '' - shows domain whois link
+
*'' 'Domain IntoDNS' '' - shows domain intoDNS link
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_12.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Profile Tabs'''<br/>
+
|style="padding: 0px 0px 20px 15px;"|In the next step set your prices.
*Tabs Map:
+
*:Select tabs that will be allowed to redirect to  from the Client's profile tooltip
+
*Columns:
+
*:Declare the number of columns to view the chosen tabs
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_13.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Quick Actions'''
+
|style="padding: 0px 0px 20px 15px;"|You may also provide the content of a welcome email.
*Select which of the available actions shall be allowed form the client's profile tooltip
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_14.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|'''Tickets'''
+
|style="padding: 0px 0px 15px 15px;"|Finally, select a group to which the package will belong to. If you do not have any groups yet, you may quickly create one right now.<br/>
*checkboxes - marking a checkbox enables counting that type of tickets as well as shows direct link to the ticket's list of that type.
+
Do not forget to press '' 'Create Package' '' button in the end.  
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_15.png]]
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 15px 15px;"|[http://www.modulesgarden.com/products/whmcs/sms_center/features '''Send SMS (Sold Separately)''']
+
|style="padding: 0px 0px 30px 15px;"|Your package is ready now, create as many packages as you need to diversify your pricing offer.
*'' 'Send SMS' '' - allows sending text messages to clients, type in the text in a box on pressing the '' '+' '' button.
+
*:''Please note that this widget works properly only with SMS Center For WHMCS module purchased, activated and correctly configured!''
+
*:''For more information on SMS Center For WHMCS, visit its [http://www.docs.modulesgarden.com/SMS_Center_For_WHMCS Wiki].''
+
|}
+
{|
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25.png]]
+
 
|}
 
|}
  
==Settings==
+
===Order Forms===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|'' 'Settings' '' page contains global settings for the module such as:<br/>
+
|style="padding: 10px 0px 20px 15px;"|Once you have your package ready, you have to create a new order form. Move to '' 'Packages' 'Order Forms' '' and press '' 'Add Order Form'.''
*'''Hide Tooltip''' - if checked, tooltip automatically disappears when cursor is moved outside of it.<br/>
+
*'''Show After''' - defines delay time for showing the tooltip.<br/>
+
*'''Hide After''' - defines delay time for hiding the tooltip when cursor is outside.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_16.png]]
 
|}
 
|}
 
==Tooltip==
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Tooltip will be displayed across the WHMCS admin area, wherever client's name is displayed.<br/>
+
|style="padding: 0px 0px 15px 15px;"|Provide '' 'Basic' '' settings for the order form that will be assigned to your previously created package.
On the following screen you can see a client tooltip in '' 'Clients' '' '' 'View/Search Clients' ''. <br/>
+
*set the status
As you know, tooltip is made of widgets, let us discuss over each of them.<br/>
+
*name the order form
''Note: Most of the widget titles are links to specific parts of the WHMCS system.''
+
*provide a unique label ''(next to the label a URL to this order form in client area will appear)
 +
*select type of the form - '' 'Domain And Other' ''
 +
*choose template from the available
 +
*configure any additional options like allowing coupons or human verification, etc
 +
*select domain package group - the one you created in the previous step
 +
*select allowed currencies and payment gateways<br/>
 +
Press '' 'Add Form' '' when everything is ready.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_17.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_17.png]]
 
|}
 
|}
  
===Assigned Admin To Client===
+
==Ordering==
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Allows you to assign admin to specific client.<br/>
+
|style="padding: 10px 0px 15px 15px;"|Ordering GoDaddy domains goes alike ordering other domains.<br/>
Admin assigned is visible only from the tooltip.
+
Check domain availability, order selected domain, make the payment and wait until it is activated.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_19.png]]
 
|}
 
|}
 +
 +
==Domain Management==
 +
===Admin Area===
 
{|
 
{|
|style="padding: 0px 0px 20px 0px;"|Once an admin is assigned they can automatically assign new tickets to the client and then stop assigning them.
+
|style="padding: 10px 0px 15px 15px;"|In the admin area you can manage all the aspects of the domain. Find the ordered domains under '' 'Services' '' table.<br/>
 +
Press '' 'Manage' '' to see details of the domain.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_18_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_20.png]]
 
|}
 
|}
 
+
====Basic Options====
===Client Custom Status===
+
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Enables you to assign custom status and color to a client.
+
|style="padding: 10px 0px 15px 15px;"|The first tab gathers data on service information, allowed actions and upgrade/downgrade feature.<br/>
 +
'''Service Information:'''
 +
*some basic data on the domain such as name, label, quantity, dates etc.<br/>
 +
'''Actions:'''
 +
*Suspend/cancel/schedule cancellation and change renew date<br/>
 +
Select action, provide details depending on the chosen action and save the changes.<br/>
 +
'''Upgrade/Downgrade'''
 +
*If set up, you may choose other package or term from available to upgrade it or downgrade.
 +
*enter coupon code to use
 +
*select prorate<br/>
 +
Again save the changes.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_21.png]]
 
|}
 
|}
  
===Profile Tabs===
+
====Name Servers====
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Quick redirection to tabs in client's profile.
+
|style="padding: 10px 0px 15px 15px;"|In the next section you can preview ordered name servers. Update them if required.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_22.png]]
 
|}
 
|}
 
+
====Settings====
===Quick Actions===
+
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|Move directly form clients profile tooltip to a chosen action section.
+
|style="padding: 10px 0px 15px 15px;"|'' 'Settings' ''  section includes important details, such as:
 +
*Domain ID
 +
*Shopper ID and Password
 +
*exact expiry date
 +
*setup options: renewable/privacy/status
 +
Here you can also:
 +
*manage the registrar lock
 +
*enable/disable auto-renewal option
 +
*preview EPP code
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_23.png]]
 
|}
 
|}
 
+
====Contact Details====
===Client Notes - Admin Notes, Notes And Custom Notes===
+
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|The screen presents three different widgets in fact, each of them displays notes from a different part of the system.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The very last section contains all contact details to:
*Client Admin Notes - manages notes from the client's profile → '' 'Sumary' '', additionally it allows you to define a maximum number of letters displayed in the tooltip.
+
*Registrant Contact
*Client Notes - manages notes from the client profile → '' 'Notes'.''
+
*Billing Contact
*Client Custom Notes - enables you to add notes visible in the tooltip only for you, your admin role or all admins.<br/>
+
*Admin Contact
Additionally, as you can see on the following screen, you can see the number of notes added and a maximum number of notes you can add.
+
*Technical Contact
 +
You may change/update the details here.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_24.png]]
 
|}
 
|}
  
===Income===
+
===Client Area===
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Income' '' widget displays the summary value of paid invoices as well as those still waiting for payment.
+
|style="padding: 10px 0px 15px 15px;"|Your customers can perform various actions on their GoDaddy domain from the client area.<br/>
 +
Clients can view basic information related to domains and perform several actions on them. Read below see exactly what can be done.<br/>
 +
In addition to that, your clients can find here their GoDaddy account details and log into it through pressing '' 'Go To Control Panel' '' button.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_21.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_25.png]]
 
|}
 
|}
===Log In As Client===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|This widget allows you to quickly log in as a client.<br/>
+
|style="padding: 0px 0px 20px 15px;"|At '' 'Information' '' tab clients can see basic details on their domain. Used package name, status, recurring amount etc.
Press '' 'Log In As Client' '' to do so.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_26.png]]
 
|}
 
|}
 
===Services===
 
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|Here you can find client's products, product addons and domains counted by their status.<br/>
+
|style="padding: 0px 0px 20px 15px;"|'' 'Nameservers' '' tab allows clients to preview and change nameservers used by their domains.
Additionally, you can view all the items in the tooltip along with various links as shown on the screen below.
+
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_27.png]]
 
|}
 
|}
 
===Tickets===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Tickets' '' widget counts your client's tickets by status and provides a direct link to them.
+
|style="padding: 0px 0px 15px 15px;"|'' 'Settings'' ' section includes:
 +
*domain management data - shopper ID and password
 +
*'' 'Go To Control Panel' '' - press to log into the panel
 +
*registrar lock -  our customers can also lock/unlock their domains to prevent them from being transferred
 +
*enable or disable auto renewal option
 +
*preview EPP code
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GDRB_28.png]]
 
|}
 
|}
===Send SMS===
 
 
{|
 
{|
|style="padding: 10px 0px 20px 15px;"|'' 'Send SMS' '' widget allows quick sending text messages. This functionality is available only if SMS Center For WHMCS is activated!
+
|style="padding: 0px 0px 20px 15px;"|Under '' 'Contact Details' '' your clients can also view and modify any contact information.
 
|}
 
|}
 
{|
 
{|
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GDRB_29.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|1. If you wish some specific information like income to be visible at the top of the tooltip, simply change its position in the configuration.<br/>
+
|style="padding: 10px 0px 30px 15px;"|1. To use the test mode, simply select '' 'Sandbox' '' under the module management page.
Drag and drop the desired widget box in a required position.  
+
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Revision as of 09:20, 9 June 2017

Contents

About Godaddy Domain Registrar For Blesta

Godaddy Domain Registrar For Blesta enables registration of GoDaddy domains in your Blesta system.

Your clients will be able to order and manage their domains directly in your Blesta client area.
The module is an excellent tool for every GoDaddy API Reseller who works with Blesta platform.

  • Client Area Features:
✔ Access Shopper ID And Password
✔ Log In To Shopper Panel
✔ Toggle Registrar Lock
✔ Toggle EPP Code Visibility
✔ Update Contact Details
  • Admin Area Features:
✔ Register/Transfer/Renew/Cancel Domain
✔ Update Nameservers
✔ Access Shopper ID And Password
✔ Toggle Registrar Lock
✔ Toggle EPP Code Visibility
✔ Update Contact Details
  • General Info:
✔ Supports 301 Different TLDs & gTLDs
✔ Multi-Language Support
✔ Supports Blesta 3.6.2

Installation and Configuration

In this brief tutorial we will show you how to successfully install and set up GoDaddy Domain Registrar For Blesta.

We will guide you step by step through the whole installation process.

Installation

1. In the beginning make sure that you are the GoDaddy API Reseller and your API User account is active.

Info: Please note that GoDaddy API Reseller and GoDaddy Reseller are not the same! Our module can be successfully used only with the former account.

2. Log in to your client area and download GoDaddy Domain Registrar For Blesta.
GDRB 1.png
3. Upload and extract the module into the main Blesta directory.

Files in your Blesta directory should look like this.

GDRB 2.png
4. When you install GoDaddy Domain Registrar for the first time you have to rename 'license_RENAME.php' file.

File is located in 'components/modules/go_daddy/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

GDRB 3.png
5. In order to configure your license key you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products'.

GDRB 4.png

Configuration

Before you can go one, you must generate your GoDaddy API Key and API Secret. You will need them to activate your registrar module.

Underneath you will find instructions where to find your API details.

6. Firstly, log into your GoDaddy account and enter site: https://developer.godaddy.com/

Find 'Keys' section.

GDRB 5.png
7. You will be moved to a section where keys can be generated and then managed. Please find 'Production' keys.
It should be seen at the bottom of the page, under 'Test' keys.
Press '+' to generate a new key.
GDRB 6.png
8. Keep your API Key and Secret in a safe place, you will need them in a moment. Note that it is not possible to vie 'API Secret' again!

Press 'OK' to finish.

GDRB 7.png
9. Now, log in to your Blesta and proceed to 'Settings' 'Modules' 'Available'.

Find 'GoDaddy Domain Registrar' and press 'Install' next to it.

GDRB 7 1.png
10. Afterwards, press 'Manage' to configure your API connection.
GDRB 8.png
11. Enter your live API 'API Key', 'API Secret' and a URL to domain management site.

Press 'Save Changes' when ready.

GDRB 9.png

Management

GoDaddy Domain Registrar allows you to offer GoDaddy TLDs through the Blesta system to your customers.

In this short guide we will present you the possibilities of our module.

Packages

New Package

Before you can offer new TLD for sale you must create some packages with selected TLDs and pricing.

Go to 'Packages' → 'Browse' and press 'Create Package'.

GDRB 10.png
You will see an extensive form. Start with naming your package, select module - 'GoDaddy Domain Registrar' and activate it now.

Surely you can activate it later on.

GDRB 11.png
Next, you have to configure your module options.
  • select type: 'Domain Registration'
  • Select TLD you wish to allow for sale in this package
  • provide default nameservers - they can be changed later on.
GDRB 12.png
In the next step set your prices.
GDRB 13.png
You may also provide the content of a welcome email.
GDRB 14.png
Finally, select a group to which the package will belong to. If you do not have any groups yet, you may quickly create one right now.

Do not forget to press 'Create Package' button in the end.

GDRB 15.png
Your package is ready now, create as many packages as you need to diversify your pricing offer.

Order Forms

Once you have your package ready, you have to create a new order form. Move to 'Packages' → 'Order Forms' and press 'Add Order Form'.
GDRB 16.png
Provide 'Basic' settings for the order form that will be assigned to your previously created package.
  • set the status
  • name the order form
  • provide a unique label (next to the label a URL to this order form in client area will appear)
  • select type of the form - 'Domain And Other'
  • choose template from the available
  • configure any additional options like allowing coupons or human verification, etc
  • select domain package group - the one you created in the previous step
  • select allowed currencies and payment gateways

Press 'Add Form' when everything is ready.

GDRB 17.png

Ordering

Ordering GoDaddy domains goes alike ordering other domains.

Check domain availability, order selected domain, make the payment and wait until it is activated.

GDRB 19.png

Domain Management

Admin Area

In the admin area you can manage all the aspects of the domain. Find the ordered domains under 'Services' table.

Press 'Manage' to see details of the domain.

GDRB 20.png

Basic Options

The first tab gathers data on service information, allowed actions and upgrade/downgrade feature.

Service Information:

  • some basic data on the domain such as name, label, quantity, dates etc.

Actions:

  • Suspend/cancel/schedule cancellation and change renew date

Select action, provide details depending on the chosen action and save the changes.
Upgrade/Downgrade

  • If set up, you may choose other package or term from available to upgrade it or downgrade.
  • enter coupon code to use
  • select prorate

Again save the changes.

GDRB 21.png

Name Servers

In the next section you can preview ordered name servers. Update them if required.
GDRB 22.png

Settings

'Settings' section includes important details, such as:
  • Domain ID
  • Shopper ID and Password
  • exact expiry date
  • setup options: renewable/privacy/status

Here you can also:

  • manage the registrar lock
  • enable/disable auto-renewal option
  • preview EPP code
GDRB 23.png

Contact Details

The very last section contains all contact details to:
  • Registrant Contact
  • Billing Contact
  • Admin Contact
  • Technical Contact

You may change/update the details here.

GDRB 24.png

Client Area

Your customers can perform various actions on their GoDaddy domain from the client area.

Clients can view basic information related to domains and perform several actions on them. Read below see exactly what can be done.
In addition to that, your clients can find here their GoDaddy account details and log into it through pressing 'Go To Control Panel' button.

GDRB 25.png
At 'Information' tab clients can see basic details on their domain. Used package name, status, recurring amount etc.
GDRB 26.png
'Nameservers' tab allows clients to preview and change nameservers used by their domains.
GDRB 27.png
'Settings ' section includes:
  • domain management data - shopper ID and password
  • 'Go To Control Panel' - press to log into the panel
  • registrar lock - our customers can also lock/unlock their domains to prevent them from being transferred
  • enable or disable auto renewal option
  • preview EPP code
GDRB 28.png
Under 'Contact Details' your clients can also view and modify any contact information.
GDRB 29.png

Tips

1. To use the test mode, simply select 'Sandbox' under the module management page.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community