Difference between revisions of "Singlehop"

From WHMCS Documentation
(→‎Configuring a Product)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
The SingleHop module allows for the management of dedicated servers provisioned through the [http://www.singlehop.com/resellers/ Tandem Reseller Program] via WHMCS. It represents a unique opportunity to automate server reselling tasks through a completely white label solution.
+
== About this Module ==
  
−
==Supported Features==
+
<div class="docs-alert-danger">
−
*Suspend Server
+
In 2013, SingleHop replaced this functionality with a built-in function in LEAP3. Contact SingleHop directly for help to configure WHMCS and LEAP3.
−
*Unsuspend Server
+
</div>
−
*Reboot Server
 
−
*View IP Addresses
 
−
*Viewing historical bandwidth usage
 
  
−
==Installation==
+
The SingleHop module allows you to manage dedicated servers that WHMCS provisions through the [http://www.singlehop.com/resellers/ Tandem Reseller Program]. It can automate server reselling tasks through a completely white label solution. This includes suspensions, unsuspensions, rebooting, and viewing IP addresses and historical bandwidth usage.
−
The module files can be downloaded from *URL HERE* then simply upload to the /modules/servers/singlehop/ folder to install.
 
  
−
==Setup/Configuration==
+
== Configuring a Product ==
−
The first step is to create a Tandem user account in your [https://leap.singlehop.com/ LEAP control panel]:
 
  
−
#Navigate to '''Leap > Tandem > Tandem Users''' and click '''Add New User'''.
+
To set up a SingleHop product:
−
#Fill in the Name, Email and Password fields to create the new user.
 
−
#Click Submit
 
  
−
[[File:Tandemcreate.png]]
+
# If you have not already created a Tandem user account, perform the following steps in the [https://leap.singlehop.com/ LEAP control panel]: <br/>[[File:Tandemcreate.png]]
 +
## Go to '''Leap > Tandem > Tandem Users''' and click '''Add New User'''.
 +
## Enter a '''Name''', '''Email''', and '''Password'''.
 +
## Click '''Submit'''.
 +
# In the WHMCS Admin Area, go to '''Setup > [[Products and Services|Products/Services]]'''.
 +
# Click '''Create a New Product'''.
 +
# Select '''VPS/Dedicated Server''' for product type.
 +
# Choose the appropriate product group and give the product a name.
 +
# Click '''Continue'''. <br/>[[File:Tandemproductsetup.png]]
 +
# In the '''Module Settings''' tab, select '''Singlehop'''.
 +
# Make certain that the server group is '''None'''.
 +
# Enter your LEAP username and password, the Tandem username and password, and the API key from the '''Accounts''' page in LEAP. [[File:Tendemmodsettings.png]]
 +
# Configure all of the remaining product settings as normal.
  
−
Login to WHMCS and create your server product as normal, the four basic steps are:
+
== The Order Process ==
  
−
#Begin by going to '''Setup > Products/Services'''
+
Automated provisioning is not possible via the API. When a client orders a server, you must order the server via the [https://leap.singlehop.com/ LEAP control panel] manually. Then, you must give the Tandem user permission to manage it:
−
#Click the '''Create a New Product''' link
 
−
#Select '''VPS/Dedicated Server''' for the Product Type
 
−
#Choose the appropriate product group and give the product a name, then click '''Continue >>'''
 
  
−
[[File:Tandemproductsetup.png]]
+
# Go to '''Leap > Tandem > Tandem Users'''.
 +
# Select the user in the left-side pane.
 +
# Click '''Add Server Permissions'''.
 +
# Check the checkbox for the new server.
 +
# Click '''Apply Permissions'''.[[File:Tandempermission.png]]
 +
# In WHMCS, go to the client's '''Products/Services''' tab.
 +
# Select the dedicated server product.
 +
# Select the new server from the '''SingleHop Servers List''' menu.
 +
# Click '''Save Changes'''. The hostname and username will populate automatically.
  
−
#On the next screen that appears, all settings can be left at their defaults
+
=== Admin Area Management Options ===
−
#Next move to the '''Module Settings''' tab and select the '''Singlehop''' module from the dropdown menu. Server Group should be left at '''None'''.
 
−
#You will then see a screen like the one below where you should enter your LEAP Username and Password, the Tandem Username and Password you created above, and the API Key from the Accounts page in LEAP.
 
  
−
[[File:Tendemmodsettings.png]]
+
The Admin Area allows you to perform suspensions, unsuspensions, and remote reboots. You can also click '''Get Server IP''' to view a list of IP addresses on the server.
  
−
That's all there is to it. You can now work through the other tabs and enter the product description, pricing and other options as normal.
+
[[File:Tandemadminmanagement.png]]
  
−
==When a Server is Ordered==
+
=== Client Area Management Options ===
−
Automated provisioning is not possible via the API, so when a client orders a server you must in turn order the server via the [https://leap.singlehop.com/ LEAP control panel] manually. Once the server is active you must give the Tandem user permission to manage it:
 
  
−
#Navigate to '''Leap > Tandem > Tandem Users''' and select the user in the left-hand pane.
+
The Client Area with this module provides clients with the ability to view their server username in real time along with historical bandwidth usage data.
−
#Click '''Add Server Permissions''' and tick the checkbox corresponding to the new server
 
−
#Click Apply Permissions
 
  
−
[[File:Tandempermission.png]]
+
[[File:Tandemclientarea.png]]
 +
 
 +
[[File:Tandemclientareabandwidthview.png]]
 +
 
 +
== Troubleshooting ==
 +
 
 +
===API Error: Authentication Error===
 +
 
 +
This error message next to SingleHop Servers List on the client's products/services tab means the details entered under '''Module Settings''' when you edit a product at '''Setup > [[Products and Services|Products/Services]]''' are incorrect.
 +
 
 +
===No Servers Listed===
 +
 
 +
If no servers are listed in the SingleHop Servers List dropdown menu on the client's profile's '''[[Clients:Products/Services Tab|Products/Services]]''' tab, this indicates your Tandem User doesn't have permission for any servers. For more information, see the instructions above.

Latest revision as of 18:52, 13 May 2022

About this Module

In 2013, SingleHop replaced this functionality with a built-in function in LEAP3. Contact SingleHop directly for help to configure WHMCS and LEAP3.

The SingleHop module allows you to manage dedicated servers that WHMCS provisions through the Tandem Reseller Program. It can automate server reselling tasks through a completely white label solution. This includes suspensions, unsuspensions, rebooting, and viewing IP addresses and historical bandwidth usage.

Configuring a Product

To set up a SingleHop product:

  1. If you have not already created a Tandem user account, perform the following steps in the LEAP control panel:
    Tandemcreate.png
    1. Go to Leap > Tandem > Tandem Users and click Add New User.
    2. Enter a Name, Email, and Password.
    3. Click Submit.
  2. In the WHMCS Admin Area, go to Setup > Products/Services.
  3. Click Create a New Product.
  4. Select VPS/Dedicated Server for product type.
  5. Choose the appropriate product group and give the product a name.
  6. Click Continue.
    Tandemproductsetup.png
  7. In the Module Settings tab, select Singlehop.
  8. Make certain that the server group is None.
  9. Enter your LEAP username and password, the Tandem username and password, and the API key from the Accounts page in LEAP. Tendemmodsettings.png
  10. Configure all of the remaining product settings as normal.

The Order Process

Automated provisioning is not possible via the API. When a client orders a server, you must order the server via the LEAP control panel manually. Then, you must give the Tandem user permission to manage it:

  1. Go to Leap > Tandem > Tandem Users.
  2. Select the user in the left-side pane.
  3. Click Add Server Permissions.
  4. Check the checkbox for the new server.
  5. Click Apply Permissions.Tandempermission.png
  6. In WHMCS, go to the client's Products/Services tab.
  7. Select the dedicated server product.
  8. Select the new server from the SingleHop Servers List menu.
  9. Click Save Changes. The hostname and username will populate automatically.

Admin Area Management Options

The Admin Area allows you to perform suspensions, unsuspensions, and remote reboots. You can also click Get Server IP to view a list of IP addresses on the server.

Tandemadminmanagement.png

Client Area Management Options

The Client Area with this module provides clients with the ability to view their server username in real time along with historical bandwidth usage data.

Tandemclientarea.png

Tandemclientareabandwidthview.png

Troubleshooting

API Error: Authentication Error

This error message next to SingleHop Servers List on the client's products/services tab means the details entered under Module Settings when you edit a product at Setup > Products/Services are incorrect.

No Servers Listed

If no servers are listed in the SingleHop Servers List dropdown menu on the client's profile's Products/Services tab, this indicates your Tandem User doesn't have permission for any servers. For more information, see the instructions above.

Retrieved from "http://3.17.75.209/index.php?title=Singlehop&oldid=32722"