Difference between revisions of "Singlehop"
From WHMCS Documentation
(→Configuring a Product) |
|||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == About this Module == | |
| − | = | + | <div class="docs-alert-danger"> |
| − | + | In 2013, SingleHop replaced this functionality with a built-in function in LEAP3. Contact SingleHop directly for help to configure WHMCS and LEAP3. | |
| − | + | </div> | |
| − | |||
| − | |||
| − | |||
| − | + | 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 | ||
| − | == | + | == Configuring a Product == |
| − | |||
| − | + | To set up a SingleHop product: | |
| − | |||
| − | |||
| − | [[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. | ||
| − | + | == The Order Process == | |
| − | + | 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: | |
| − | |||
| − | |||
| − | |||
| − | [[File: | + | # 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. | ||
| − | + | === 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. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[File:Tandemadminmanagement.png]] | [[File:Tandemadminmanagement.png]] | ||
| − | ==Client Area Management Options== | + | === Client Area Management Options === |
| − | The | + | 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. |
[[File:Tandemclientarea.png]] | [[File:Tandemclientarea.png]] | ||
| + | |||
[[File:Tandemclientareabandwidthview.png]] | [[File:Tandemclientareabandwidthview.png]] | ||
| − | ==Troubleshooting== | + | == Troubleshooting == |
| + | |||
===API Error: Authentication Error=== | ===API Error: Authentication Error=== | ||
| − | This error message next to SingleHop Servers List on the client's products/services tab means the details entered under Setup > Products/Services | + | |
| + | 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=== | ===No Servers Listed=== | ||
| − | If no servers are listed in the SingleHop Servers List dropdown menu on the client's | + | |
| + | 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
Contents
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:
- If you have not already created a Tandem user account, perform the following steps in the LEAP control panel:
- 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/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.
- 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.
- 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:
- 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.
- 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.
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.
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.
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.