Adding a server into WHMCS allows you to integrate and manage hosting services from a specific server within the WHMCS platform. This Knowledge Base (KB) article will guide you through the process of adding a server into WHMCS using API token authentication, ensuring secure and efficient integration of your hosting services.
Step 1: Log in to WHMCS Admin Area Access your WHMCS Admin Area using your credentials.
Step 2: Navigate to the Servers Configuration Section Once logged in, locate the "Setup" tab in the top navigation bar. From the drop-down menu, select "Products/Services" and then click on "Servers" from the side menu.
Step 3: Add New Server On the "Servers" page, click on the "Add New Server" button located at the top right corner.
Step 4: Provide Server Details In the "Add New Server" form, fill in the following information:
- Server Name: Enter a unique name to identify the server within WHMCS.
- Server IP Address: Input the IP address of the server.
- Type: Choose the appropriate server type from the available options (e.g., cPanel, Plesk, DirectAdmin, etc.).
- Assigned IP Address: Specify the primary IP address associated with the server.
- WHM Username: Enter the username used to access the WHM (Web Host Manager) control panel of the server.
Step 5: Generate API Token To create an API token for authentication, follow these steps:
- Log in to the WHM control panel of the server using the WHM username and password.
- Navigate to "Home » Development » Manage API Tokens" in WHM.
- Click on the "Generate Token" button.
- Provide a description for the token, e.g., "WHMCS Integration".
- Select the desired privileges for the token, ensuring it has sufficient access to manage hosting accounts.
- Click on the "Generate" button to create the API token.
Step 6: Configure API Token Authentication in WHMCS Back in the WHMCS Admin Area, continue configuring the server by completing these steps:
- Copy the generated API token from WHM.
- Return to the "Add New Server" form in WHMCS.
- Paste the API token in the "Password" field instead of using the WHM password.
- Leave the "WHM Password" field empty.
- Complete any additional fields required based on the server type and configuration.
Step 7: Test Connection Click on the "Test Connection" button to verify the connection between WHMCS and the server. This ensures that WHMCS can communicate with the server using the API token for authentication.
Step 8: Save Server Settings If the connection test is successful, click on the "Save Changes" button to save the server settings. WHMCS will validate the information and add the server to its configuration.
Step 9: Configure Product/Service Module To use the server for hosting services, you need to configure the corresponding product/service module. This module determines how WHMCS communicates with the server and manages the hosting accounts. To configure the module, follow the steps below:
- Return to the "Servers" page in the WHMCS Admin Area.
- Find the newly added server in the list and click on the "Configure" button next to it.
- Configure the module settings according to your server's requirements.
- Save the changes.
Step 10: Test Product/Service Module After configuring the module, it is essential to test its functionality. You can perform a test by creating a product/service using the newly added server and ensuring that the provisioning process works correctly.
Conclusion: By following these step-by-step instructions, you can easily add a server into WHMCS using API token authentication. This secure integration method ensures efficient management and provisioning of hosting accounts through WHMCS, enhancing the overall functionality of your hosting business.