Difference between revisions of "InterWorx"

From WHMCS Documentation

Line 11: Line 11:
 
WHMCS technical support cannot assist with recompiling PHP, please contact your server admin/hosting provider for assistance.
 
WHMCS technical support cannot assist with recompiling PHP, please contact your server admin/hosting provider for assistance.
  
==Important Notes==
+
==Adding an InterWorx Server==
  
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.
+
#Begin by going to '''Setup > Products/Services > Servers '''
 +
#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
  
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.
+
==Setting up an Interworx Package==
  
'''If WHMCS is installed on the same InterWorx server that you will be setting up accounts on...'''
+
# Navigate to '''Setup > Products/Services >  Products/Services'''
 +
# Click ''Create A New Product''.
 +
#Configure the name, description, pricing and other options as necessary.
 +
# On the ''Module Settings'' tab 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.
  
When as part of the account creation process InterWorx restarts apache, it will kill the WHMCS process, causing a problem.  To prevent that, edit /usr/local/interworx/iworx.ini, and change the line
+
==Common Problems==
 +
===WHMCS is installed on the InterWorx server===
  
  force_graceful="0"
+
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
 +
 
 +
<source lang="php">
 +
force_graceful="0"
 +
</source>
  
 
to
 
to
  
 +
<source lang="php">
 
  force_graceful="1"
 
  force_graceful="1"
 
+
</source>
  
 
{{modules}}
 
{{modules}}

Revision as of 09:49, 23 December 2015

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

Additional Requirement

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.

WHMCS technical support cannot assist with recompiling PHP, please contact your server admin/hosting provider for assistance.

Adding an InterWorx Server

  1. Begin by going to Setup > Products/Services > Servers
  2. Click Add New Server
  3. Enter the server name, IP address, select the server type "interworx" from the dropdown menu
  4. 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.
  5. 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.
  6. Click Create Server to complete the process and add your new Interworx Server

Setting up an Interworx Package

  1. Navigate to Setup > Products/Services > Products/Services
  2. Click Create A New Product.
  3. Configure the name, description, pricing and other options as necessary.
  4. On the Module Settings tab 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

force_graceful="0"

to

 force_graceful="1"

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