Difference between revisions of "TransIP"

From WHMCS Documentation

(→‎Activation)
 
(3 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
| emailforwarding = yes
 
| emailforwarding = yes
 
}}
 
}}
−
 
+
−
==Activation==
+
==Activation and Configuration==
 
To activate and begin using the TransIP registrar module, follow the steps below:
 
To activate and begin using the TransIP registrar module, follow the steps below:
−
 
+
−
# Log in to your WHMCS Admin Area.
+
# Log in to the WHMCS Admin Area.
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
−
# Locate Transip in the list.
+
# Click '''Activate''' for '''Transip'''.
−
# Click the '''Activate''' button.
+
# Enter your TransIP API credentials:
−
# Enter your TransIP API credentials.
+
#* For '''TransIP Region''', select the TransIP brand that corresponds to your TransIP account (''transip.nl'', ''transip.be'', or ''transip.eu''). In WHMCS 8.4 and earlier, this was '''Endpoint'''.
−
# Click Save Changes to complete the process.
+
#* For '''Username''', enter the username that you use to log in to the TransIP website. In WHMCS 8.4 and earlier, this was '''Login'''.
−
 
+
#* For '''Private Key''', enter a private key that you generate in the TransIP control panel. To do this, go to '''Account > My Account > API''' in the TransIP control panel, enter a label, and click '''Add Key Pair'''. Then, copy-and-paste the private key into WHMCS.
−
<div class="docs-alert-warning">Before you can begin using the TransIP API with your account you must authorize your server IP for access to your account. See below for steps to do this.</div>
+
# Check '''Test Mode''' if you want to test the WHMCS integration with the TransIP sandbox.
−
 
+
#* While '''Test Mode''' is selected, you and your customers will be unable to register domains through TransIP.
 +
#* Make '''certain''' that you deselect '''Test Mode''' when you are not actively testing TransIP registrations.
 +
# Click '''Save Changes'''.
 +
 +
<div class="docs-alert-warning">Before you can begin using the TransIP API with your account, you must authorize your server IP address for access to your account (see below).</div>
 +
 
===IP Registration===
 
===IP Registration===
 
[[File:Trans ip1.png|thumb|IP Registration]]
 
[[File:Trans ip1.png|thumb|IP Registration]]
−
* Transip's API is IP restricted.
+
−
* This is done via the TransIP control panel, navigate to '''My Account > API'''.
+
Optionally, you can enable IP address restriction in the TransIP control panel at  '''Account > My Account > API'''. You can find the IP address to whitelist at '''Help > License Information''' in the WHMCS Admin Area.
−
* You can find the IP you need them to whitelist by navigating to '''Help > License''' Information within your WHMCS admin area.
+
−
 
+
==Auto Registration==
−
===Configuration===
+
By default, TransIP does '''not''' provide a method to renew domains on demand and so WHMCS cannot automate renewals for them. Instead, TransIP automatically renews domain registrations from within the TransIP control panel.
−
To setup the TransIP Registrar integration in WHMCS, begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''. Next, click Activate next to TransIP from the list of available registrars to view the configurable options for it. The options are described below:
+
−
 
+
You can enable automatic renewals at at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Pricing]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Pricing'''.
−
[[File:Trans ip3.png|thumb|Module Settings]]
+
−
[[File:Trans ip2.png|thumb|Private Key Generation]]
+
==Company Information==
−
{| class="wikitable"
+
−
|-
+
<div class="docs-alert-warning">
−
! Setting Name: Endpoint
+
<span class="title">WHMCS 8.6 and later</span><br />
−
|-
+
We added the '''Company Type''', '''Company Name''', and '''Company Number''' text boxes in WHMCS 8.6.
−
|TransIP operates three brands; transip.nl, transip.be and transip.eu. The module works with all three, provided you select the correct brand with whom your account is held. So for example if you login at http://transip.eu you would select "api.transip.eu" from this menu.
+
</div>
−
|-
+
−
! Setting Name: Login
+
If a client registering a domain is representing a company, their domain configuration includes a company name and company number.
−
|-
+
−
|Enter the username with which you login to the TransIP website
+
In order to display these text boxes during checkout, you '''must''' select ''TransIP'' for '''Auto Registration''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Pricing]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Pricing'''. If you do not or if the client does not enter this information, the domain registration will not include a company.
−
|-
+
−
! Setting Name: PrivateKey
+
To translate these field names, use the following <tt>LangVar</tt> keys:
−
|-
+
−
|The Private Key is generated in the TransIP control panel, navigate to '''My Account  > API '''. Create your Private Key Pairs by choosing a label (for example ''whmcs'') and click '''Add Key Pair'''.
+
<table class="table table-striped table-condensed">
−
<br>
+
<tr><th>LangVar Key</th><th>Description</th></tr>
−
The private key will be presented to be copied and pasted into WHMCS.
+
<tr><td><tt>TIPCompanyType</tt></td><td>The company's type.</td></tr>
−
|}
+
<tr><td><tt>TIPCompanyName</tt></td><td>The company name.</td></tr>
−
 
+
<tr><td><tt>TIPCompanyNumber</tt></td><td>The company number.</td></tr>
−
==Automatic Registration==
+
</table>
−
WHMCS allows you to setup automatic domain registration on a per extension basis enabling you to use different registrars for different TLDs to give you the flexibility to offer more extensions and always get the best value.
+
−
To enable automatic registration, please refer to [[Domain Pricing|Configuring Automatic Registration]]
+
For more information, see [[Additional Domain Fields]]. 
−
 
+
 
==Troubleshooting==
 
==Troubleshooting==
−
'''Partially Loaded Page'''<br>
+
−
If your server doesn't have SOAP compiled with the required functions in PHP by default then you will may find the module fails to operate entirely. To resolve this you will need to recompile PHP with SOAP support.
+
===Partially Loaded Page===
−
 
+
In WHMCS 8.4 and earlier, if your server doesn't have SOAP compiled with the required functions in PHP by default, the module may fail. To resolve this, recompile PHP with SOAP support.
−
'''Updates Not Taking Effect'''<br>
+
−
Due to the volume of requests throughout the day, the process happens asynchronously. Which basically means that the actual registration/updates attempt may happen up to a few minutes in the future, together with any exception triggered at the registries themselves by invalid data.
+
===Updates Not Taking Effect===
−
 
+
Due to the volume of requests throughout the day, the update process happens asynchronously. There may be a period of several minutes between a change and the corresponding update.
−
So for example if a nameserver change is showing as pending in your Transip control panel, it may not be possible to make other changes to the domain until the nameserver change has been processed.
+
−
 
+
For example, if a nameserver change displays as pending in the Transip control panel, you may not be able to make other changes to the domain until the nameserver change has been processed.
 
{{modules}}
 
{{modules}}

Latest revision as of 19:29, 6 October 2022

Supported Features

Register Transfer Renew Registrar Lock
Yes Yes Yes Yes
Update Nameservers Update WHOIS Get EPP Code Register Nameservers
Yes Yes Yes No
DNS Record Management Email Forwarding Domain Release Domain Sync Script
Yes Yes No No
Premium Domains Transfer Out Automation TLD Pricing Sync
No No No

Activation and Configuration

To activate and begin using the TransIP registrar module, follow the steps below:

  1. Log in to the WHMCS Admin Area.
  2. Navigate to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
  3. Click Activate for Transip.
  4. Enter your TransIP API credentials:
    • For TransIP Region, select the TransIP brand that corresponds to your TransIP account (transip.nl, transip.be, or transip.eu). In WHMCS 8.4 and earlier, this was Endpoint.
    • For Username, enter the username that you use to log in to the TransIP website. In WHMCS 8.4 and earlier, this was Login.
    • For Private Key, enter a private key that you generate in the TransIP control panel. To do this, go to Account > My Account > API in the TransIP control panel, enter a label, and click Add Key Pair. Then, copy-and-paste the private key into WHMCS.
  5. Check Test Mode if you want to test the WHMCS integration with the TransIP sandbox.
    • While Test Mode is selected, you and your customers will be unable to register domains through TransIP.
    • Make certain that you deselect Test Mode when you are not actively testing TransIP registrations.
  6. Click Save Changes.
Before you can begin using the TransIP API with your account, you must authorize your server IP address for access to your account (see below).

IP Registration

IP Registration

Optionally, you can enable IP address restriction in the TransIP control panel at Account > My Account > API. You can find the IP address to whitelist at Help > License Information in the WHMCS Admin Area.

Auto Registration

By default, TransIP does not provide a method to renew domains on demand and so WHMCS cannot automate renewals for them. Instead, TransIP automatically renews domain registrations from within the TransIP control panel.

You can enable automatic renewals at at Configuration () > System Settings > Domain Pricing or, prior to WHMCS 8.0, Setup > Products/Services > Domain Pricing.

Company Information

WHMCS 8.6 and later
We added the Company Type, Company Name, and Company Number text boxes in WHMCS 8.6.

If a client registering a domain is representing a company, their domain configuration includes a company name and company number.

In order to display these text boxes during checkout, you must select TransIP for Auto Registration at Configuration () > System Settings > Domain Pricing or, prior to WHMCS 8.0, Setup > Products/Services > Domain Pricing. If you do not or if the client does not enter this information, the domain registration will not include a company.

To translate these field names, use the following LangVar keys:

LangVar KeyDescription
TIPCompanyTypeThe company's type.
TIPCompanyNameThe company name.
TIPCompanyNumberThe company number.

For more information, see Additional Domain Fields.

Troubleshooting

Partially Loaded Page

In WHMCS 8.4 and earlier, if your server doesn't have SOAP compiled with the required functions in PHP by default, the module may fail. To resolve this, recompile PHP with SOAP support.

Updates Not Taking Effect

Due to the volume of requests throughout the day, the update process happens asynchronously. There may be a period of several minutes between a change and the corresponding update.

For example, if a nameserver change displays as pending in the Transip control panel, you may not be able to make other changes to the domain until the nameserver change has been processed.

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


Retrieved from "http://3.17.75.209/index.php?title=TransIP&oldid=33561"