Difference between revisions of "InterWorx"

Latest revision as of 15:54, 10 January 2023

About this Module

The InterWorx module allows you to add and manage InterWorx servers in WHMCS.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

Change Package	Change Password	Usage Updates	Client Area Link
Yes	Yes	Yes	Yes

The following ports should be open for outbound connections from your WHMCS server: 2443

Adding an InterWorx Server

To set up an InterWorx server in WHMCS:

Make certain that your server's PHP complication includes SOAP.
- You can check this at Utilities > System > PHP Info.
- WHMCS Technical Support cannot assist with recompiling PHP. For help, contact your system administrator or hosting provider.
Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
Click Add New Server.
Select InterWorx from the menu.
Enter the hostname or IP address.
Enter a username and password or access hash.
Click Continue.
Enter the desired additional server information.
Examine the displayed default port. If your server uses a different port, check Override with Custom Port and enter the correct port. For more information, see Server Port Overrides.
Click Save Changes.
If this is the only InterWorx server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.

Creating an InterWorx Product

You can create a product that provisions accounts on your InterWorx server at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

WHMCS is installed on the InterWorx server

When as part of the account creation process InterWorx restarts apache, therefore if WHMCS is installed on the same server upon which the account is being provisioned, it will kill the WHMCS process causing a problem.

To prevent that, adjust the InterWorx Webserver Settings so Force Graceful Restart is On.

When a user clicks Log in to SiteWorx in the Client Area, the system uses the email address on the client's profile in conjunction with the password of the client's service. When manually importing services, ensure the client's email address in WHMCS matches the email address for the account in InterWorx.

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible

@@ Line 1: / Line 1: @@
+== About this Module ==
+The InterWorx module allows you to add and manage InterWorx servers in WHMCS.
 {{Provisioning_Module
 | changepackage = Yes
@@ Line 5: / Line 8: @@
 | clientarealink = Yes
 | port = 2443}}
+== Adding an InterWorx Server ==
+To set up an InterWorx server in WHMCS:
-==Additional Requirement==
+# Make certain that your server's PHP complication includes SOAP.
-The InterWorx module requires SOAP compiled in your server's PHP configuration. In your WHMCS administration navigate to '''Utilities > System > PHP Info''' if you see no mention of SOAP then it is likely you will need to recompile.
+#* You can check this at '''Utilities > System > [[PHP Info]]'''.
+#* WHMCS Technical Support cannot assist with recompiling PHP. For help, contact your system administrator or hosting provider.
-WHMCS technical support cannot assist with recompiling PHP, please contact your server admin/hosting provider for assistance.
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
+# Click '''Add New Server'''.
+# Select ''InterWorx'' from the menu.
+# Enter the hostname or IP address.
+# Enter a username and password or access hash.
+# Click '''Continue'''.
+# Enter the desired additional server information.
+# Examine the displayed default port. If your server uses a different port, check '''Override with Custom Port''' and enter the correct port. For more information, see [[Server Port Overrides]].
+# Click '''Save Changes'''.
+# If this is the only InterWorx server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.
-==Adding an InterWorx Server==
+=== Creating an InterWorx Product ===
+You can create a product that provisions accounts on your InterWorx server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
-#Begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
+=== WHMCS Connect ===
-#Click ''Add New Server''.
-#Enter the server name, IP address, select the server type "interworx" from the dropdown menu
-#With InterWorx, a key is used for communicating with the API. Therefore when configuring an InterWorx server inside WHMCS, all you need to do is enter the API Key into the Access Hash field. Username and password are not required.
-# The default port will be displayed. If your server is configured to communicate on a different port, tick the '''Override with Custom Port''' checkbox and enter it into the Port field. For more information refer to [[Server Port Overrides]].
-#Click Create Server to complete the process and add your new Interworx Server
-==Setting up an Interworx Package==
+This module does not support [[WHMCS Connect]].
-# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
+==Troubleshooting==
-# Click ''Create A New Product''.
-#Configure the name, description, pricing and other options as necessary.
-# On the ''Module Settings'' tab select '''interworx'''
-# Packages are then configured by entering the package name as it appears in InterWorx and the theme to set as the default for the new account. Both the package name and theme name are case sensitive, so should be entered exactly as they appear in Interworx. Should the capitalisation be incorrect this would cause an error to occur.
-==Common Problems==
 ===WHMCS is installed on the InterWorx server===
-When as part of the account creation process InterWorx restarts apache, therefore if WHMCS is installed on the same server upon which the account is being provisioned, it will kill the WHMCS process causing a problem.  To prevent that, edit /usr/local/interworx/iworx.ini, and change the line
+When as part of the account creation process InterWorx restarts apache, therefore if WHMCS is installed on the same server upon which the account is being provisioned, it will kill the WHMCS process causing a problem.
-<source lang="php">
+To prevent that, adjust the [https://appendix.interworx.com/current/user_guide/nodeworx-webserver-guide.html#web-server-options InterWorx Webserver Settings] so '''Force Graceful Restart''' is ''On''.
-force_graceful="0"
-</source>
-to
-<source lang="php">
+<div class="docs-alert-info">
- force_graceful="1"
+When a user clicks '''Log in to SiteWorx''' in the Client Area, the system uses the email address on the [[Clients:Profile_Tab|client's profile]] in conjunction with the password of the [[Clients:Products/Services_Tab|client's service]]. When [[Migration_Guide#Adding_Services|manually importing services]], ensure the client's email address in WHMCS matches the email address for the account in InterWorx.
-</source>
+</div>
 {{modules}}

Documentation