WHMCS Billing Module for XtreamUI: Difference between revisions

← Older edit

@@ Line 1: / Line 1: @@
 == Overview ==
-This module allows Users to be auto-provisioned instantly on payment for XtreamUI. Automates the adding of credits for Reseller's and Users.
+This WHMCS module allows Users to be auto-provisioned instantly for Xtream-UI. It Automates the adding of credits for Reseller's and Users.
 == Requirements ==
@@ Line 7: / Line 7: @@
 Requirement Minimum Recommended PHP Version 7.2 Latest 7.3 or 7.4 Release PHP Memory Limit 64MB 128MB**
+If you are using shared hosting your provider may be blocking outbound ports. Most Shared hosting providers do this. Contact your hosting provider and get them to open the port that your reseller panel is on. i.e XtreamUI default port is 25500 unless this has changed get them to open the port. Most providers will open the port.
+We have our own CPanel servers that will work out of the box. [https://xtreamresell.com/index.php?rp=/store/cpanel-shared-hosting click here for pricing]
 == Installation and Configuration ==
@@ Line 26: / Line 29: @@
 . Extract the package and upload its contents
-'''addonxuiresell''' will be uploaded to whmcs/modules/addons
+'''addoonxtreamresell''' will be uploaded to whmcs/modules/addons
-'''xuiresell''' will be uploaded to whmcs/modules/servers
+'''xtreamresell''' will be uploaded to whmcs/modules/servers
 The content of the package to upload should look like this.
@@ Line 47: / Line 50: @@
 . Click Activate.
-. Click Configure.
+. Click Configure. Paste your License Key in, Check the box "Full Administrator" and click Save.
-. Paste your License Key in, Check the box "Full Administrator" and click Save.
 [[File:Xtreamui5.png|800px]]
 === How to Configure ===
+. Enable "Attempt to load all files" in "Encoded File Loading" by doing this. Click "System Settings" > "General Setting" > "Other" and check the box "Attempt to load all files".
+[[File:Xtreamui16.png|800px]]
 . In order to create and configure a product, go to 'System Settings' → 'Products/Services'.
@@ Line 119: / Line 124: @@
 [[File:Xtreamui10.png|800px]]
+. Once Signed up go to your dashboard and copy your "API Key" and enable "100 recognition".
+[[File:Xtreamui11.png|800px]]
+. Go to your panel login screen and "right click" anywhere on the page and click "Page Source".
+[[File:Xtreamui12.png|800px]]
+. look for data-sitekey="***************************************" You will find this near the bottom.
+[[File:Xtreamui13.png|800px]]
+. Now to go to your module settings. In the field "Captcha API Key" put the api key from 2captcha. In the "G-Recaptcha Key" put the key you copied from your Panel page source. Check the box "Captcha Required" and Check the box "Refresh" and click save. NOTE: You only click "Refresh" once. This will force ProjectX to login to your panel to get your products. This could take up to a minute to complete. If nothing has happend by then just close go back to "products and services" and reopen the module again. Refresh should auto uncheck once your products have been retrieved.
+[[File:Xtreamui14.png|800px]]
+=== Setting up Email templates ===
+. Now we need to setup the Email templates. Go to "System Settings" > "Email Templates". Click "Create New Email Template".
+[[File:step20.jpg|800px]]
+. For "Email Type" select "Product/Service". NOTE: It will default to "General" make sure to change that to "Product/Service". For "Unique Name" enter "New Account Information" NOTE; it must be called exactly that and is case-sensitive. Click create.
+[[File:step21.jpg|800px]]
+. For "Subject" again enter "New Account Information" exactly like that. Change "Font Family" to "Courier New" This will make sure Alpha Numeric characters are show properly i.e l and L. Next paste the below test in and click save. NOTE you can edit this but take Note of the service fields such as {$service_username} etc. The {$service_domain} field is retrieved from the earlier module field "Domain URL"
+Dear {$client_name},
+Your order for {$service_product_name} has now been activated. Please keep this message for your records.
+Product Details are :
+Product/Service: {$service_product_name}
+Payment Method: {$service_payment_method}
+Amount: {$service_recurring_amount}
+Billing Cycle: {$service_billing_cycle}
+Next Due Date: {$service_next_due_date}
+Your M3U is :
+NOTE: This is Case Sensitive:
+{$service_domain}get.php?username={$service_username}&password={$service_password}&type=m3u_plus&output=ts
+Your Electronic Programme Guide is:
+{$service_domain}xmltv.php?username={$service_username}&password={$service_password}
+Login Details :
+Server={$service_domain}
+Username :{$service_username}
+Password : {$service_password}
+Thanks for choosing us.
+{$signature}
+. If you use MAG boxes please create a new template with the following as well For "Email Type" select "Product/Service". NOTE: It will default to "General" make sure to change that to "Product/Service". For "Unique Name" enter "	New Account Information MAGBOX" NOTE; it must be called exactly that and is case-sensitive. Click create.
+[[File:step21.jpg|800px]]
+. For "Subject" again enter "	New Account Information MAGBOX" exactly like that. Change "Font Family" to "Courier New" This will make sure Alpha Numeric characters are show properly i.e l and L. Next paste the below test in and click save. NOTE you can edit this but take Note of the service fields such as {$service_username} etc. The {$service_domain} field is retrieved from the earlier module field "Domain URL"
+Dear {$client_name},
+Your order for {$service_product_name} has now been activated. Please keep this message for your records.
+Product Details are :
+Product/Service: {$service_product_name}
+Payment Method: {$service_payment_method}
+Amount: {$service_recurring_amount}
+Billing Cycle: {$service_billing_cycle}
+Next Due Date: {$service_next_due_date}
+Login Details
+Portal: {$service_domain}
+Your MAC is: {$service_username}
+Thanks for choosing us.
+{$signature}
+. Proceed back to "Products and Services" and lets configure the "Welcome Emails" for your products. For "Trials" select "New Account Information".
+[[File:step22.jpg|800px]]
+. For Paid subscriptions make sure to set the "Welcome Email" to "NONE". When the product is setup it will look for the Template "New Account Information" and send that.
+[[File:step23.jpg|500px]]
+=== Configuring Reseller Credits ===
+To add a product to automatically provision Reseller credits add the product normally. There are a few small differences we will explain here.
+. For Reseller Credits, in the Pricing tab set Billing to "One Time".
+[[File:step24.jpg|800px]]
+. In Module settings select the check box "Reseller Credits" and set the "Credit Amount" field to the amount of credits to be added to the reseller account.
+[[File:Xtreamui15.png|800px]]
+. In "Custom Fields" set the "Field Name" to "Reseller" this must start with a capital R. Set "Required Field" > on "Show on Order Form" > on  "Show on Invoice" > on.
+[[File:step26.jpg|800px]]
+=== Troubleshooting ===
+'''''I can't see my products in the module settings.'''''
+If you are using shared hosting your provider may be blocking outbound ports. Most Shared hosting providers do this. Contact your hosting provider and get them to open the port that your reseller panel is on. i.e XtreamUI default port is 25500 unless this has changed get them to open the port. Most providers will open the port.
+We have our own CPanel servers that will work out of the box. [https://xtreamresell.com/index.php?rp=/store/cpanel-shared-hosting click here for pricing]
+----
+'''''My licence has expired but its a valid license'''''
+In Whmcs go to "System Settings" > "Addon Modules".
+Click Deactivate.
+Click Activate.
+Click Configure. Paste your License Key in again, Check the box "Full Administrator" and click Save. (Don't miss a step).
+----