How do I connect my InterWorx reseller account to WHMCS? Print

In short: A reseller can connect an existing NodeWorx account to a separate WHMCS installation using that reseller account's API key. This allows WHMCS to provision and manage SiteWorx accounts owned by the reseller.

Before you begin

• You need an active Virgo Networks reseller-hosting account with NodeWorx access.
• Your WHMCS server must be able to make outbound HTTPS connections to TCP port 2443.
• PHP SOAP support must be available to the WHMCS installation.
• Create the required hosting packages in NodeWorx before configuring the matching WHMCS products.

1. Obtain the reseller API key

1. Sign in to NodeWorx using the existing reseller account.
2. Go to NodeWorx > API Key.
3. If a key already exists and is in use, retain it. Otherwise, select Generate.
4. Copy the complete key, including its begin and end lines, and store it securely.

Regenerating or deleting the key immediately invalidates the old one. Any connected application must then be updated with the replacement key.

2. Add the server in WHMCS

1. In your WHMCS administration area, go to Configuration > System Settings > Servers.
2. Select Add New Server and choose InterWorx.
3. Enter the InterWorx hostname supplied with your reseller service.
4. Enable a secure connection and confirm that the port is 2443.
5. For API-key authentication, enter the NodeWorx API key in the Access Hash field. Do not enter it into the server username, product username or a client-facing field.
6. Test the connection, then save the server only when the test succeeds.

3. Configure the WHMCS product

1. Go to Configuration > System Settings > Products/Services and edit the product.
2. On Module Settings, select the InterWorx module and the server or server group just created.
3. Select or enter the NodeWorx package exactly as it appears in NodeWorx. Package and theme names may be case-sensitive.
4. Choose the intended automatic setup behaviour and save the product.

Test safely

1. Use a clearly identified test order and a domain you control.
2. Run the module's connection test before attempting account creation.
3. Provision once, then verify in NodeWorx that exactly one SiteWorx account was created under the correct reseller.
4. If WHMCS reports a timeout or error, check NodeWorx before retrying; the server-side action may have completed even though WHMCS did not receive the response.
5. Remove the test service only after confirming its exact domain, owner and purpose.

Troubleshooting

• Review Utilities > Module Queue and the module log under Configuration > System Logs.
• Confirm outbound TCP port 2443, PHP SOAP support, the secure hostname and the complete API key.
• Confirm that the package exists under the same reseller account used by the API key.
• Do not email or paste an API key into an ordinary support reply. If support needs it, agree a secure exchange method first.

Further reading: InterWorx: Manage API keys, WHMCS: InterWorx server module, and WHMCS: Server configuration.