For partners

/
/
/
Reselling ispmanager modules through WHMCS

Reselling ispmanager modules through WHMCS

Ispmanager NOC module for WHMCS offers automated reselling of ispmanager modules through WHMCS.

Module features

FeaturePartnerClient
Order✅✅
Renewal✅✅
Suspension✅✅
Change of billing period✅❌

Module requirements

The recommended WHMCS version is 8.9 or higher.

The ispmanager NOC module is available for free after installation.

Module installation

  1. Connect to the WHMCS server via SSH.

  2. Go to the modules directory. The modules directory is located in the directory where WHMCS was installed to. 

    cd /ROOT_WHMCS/modules/

  3. Download the ispmanager NOC module:

     wget https://www.ispmanager.com/static/files/whmcs/whmcs_ispmanager_noc.zip
    If the terminal does not read the wget utility

    Install the utility:

    For Debian-based operating systems
    apt install wget
    For RHEL-based operating systems
    yum install wget

  4. Unpack the module in the modules directory:

    unzip whmcs_ispmanager_noc.zip
    If the terminal does not read the unzip utility 

    Install the utility:

    For Debian-based operating systems
    apt install unzip
    For RHEL-based operating systems
    yum install unzip

After unpacking, the module will be automatically activated and available for use. To verify:

  1. Log in to WHMCS as an administrator account at https://YOUR_DOMAIN/admin.
  2. Go to Configurations → Apps & Integrations.
  3. Search for "ispmanager." The ispmanager NOC module marked as Active should appear on the list.

Setting up integration between WHMCS and ispmanager

To resell modules, set up integration between WHMCS and ispmanager. First, create a server in WHMCS and specify your ispmanager account credentials. If you use multiple ispmanager accounts for reselling, create a server for each.

Next, to automatically order moduls, link the created server to modules in the service settings. Linking is only available for:

If you use a single ispmanager account to resell SSL certificates, licenses, and ispmanager modules, simply designate the ispmanager server as the default.

If you use multiple accounts, create a separate group for each ispmanager server.

Creating a server

  1. If you don't have an ispmanager account yet, create one.
  2. Log in to WHMCS as an administrator at https://YOUR_DOMAIN/admin.
  3. Go to Configurations → System Settings.
  4. Select the Servers section.
  5. Click Add New Server.
  6. Fill in the fields. Required fields are marked with asterisks.
    • Module* — select "ispmanager NOC"
    • Hostname or IP Address* — enter the domain name of your ispmanager account — eu.ispmanager.com
    • Username* — username in your ispmanager account
    • Password* — user password in your ispmanager account
    • Access Hash — leave blank
  7. Click Continue.
  8. Fill in the rest of the fields. Required fields are marked with asterisks.
    • General information:
      • Name* — an arbitrary name under which the ispmanager server will be saved in WHMCS. The server name will only be viewable by the WHMCS administrator.
      • Assigned IP Addresses — leave this field blank.
      • Monthly Cost — leave this field blank.
      • Datacenter/NOC — leave this field blank.

      • Maximum No. of Accounts — the limit on the number of modules available for resale using the server. This value is used to calculate the server occupancy rate in the group when distributing ordered modules among the servers. If the server is not added to the group or is the only server in the group, this value is not applied.

        The actual number of ispmanager modules available for resale is not limited.

      • Server Status Address — leave this field blank.
      • Enable/Disable — server status: enabled/disabled. A disabled server cannot be connected to a new service when creating it. Existing services linked to a disabled server will remain available for ordering but a license will not be automatically ordered for them.
    • Nameservers — leave these fields blank.
    • SSO Access Control — single sign-on access:
      • Unrestricted — unlimited: allow all WHMCS administrators to automatically log in to the ispmanager dashboard.
      • Restricted — limited: allow automatic authorization to the ispmanager dashboard only for WHMCS administrators and users with the specified role:
        • Full Administrator — full administrator
        • Sales Operator — sales department operator
        • Support Operator — technical support operator
  9. Click Save Changes.

Creating a server group

Create a server group if you use multiple ispmanager accounts for reselling. This will allow you to link the group to modules in the service settings and automate their ordering.

  1. Log in to WHMCS as an administrator at https://YOUR_DOMAIN/admin.
  2. Go to Configurations → System Settings.
  3. Select the Servers section.
  4. Click Create New Group.
  5. Fill in the fields:
    • Name — the name under which the group will be saved in WHMCS. The group name will only be viewable to the WHMCS administrator.

    • Fill Type — the rule by which a server in the group will be selected for ordering ispmanager licenses if the group contains multiple servers.

      • Add to the least full server —licenses will be ordered through the server with the most amount of available space.
      • Fill active server until full then switch to next least used — if the default server is not in the group, licenses will be ordered through the default server or the first server in the alphabetical order until it is full, then through the server with the most amount of available space.

      Server capacity is calculated based on the ratio of existing orders to the maximum allowed number of orders.

    • Selected Servers — servers in a group. To add a server to a group, select it in the left column and click Add:

  6. Click Save Changes.

Default server

Each module in WHMCS is assigned a default server. The default server is used:

  • if a server group is not specified in the module settings when creating a service (None option is selected)
  • as a priority within a server group

A single server is automatically designated as the default server.

If there are multiple servers, to designate one as the default server, click its name in the list. An asterisk will appear next to the default server:

Creating services in WHMCS

Creation of services is available after creating at least one service group.

Service groups

When adding services to groups on the customer order page, the services will be joined into groups in the Categories section.

  1. Log in to WHMCS as an administrator at https://YOUR_DOMAIN/admin.
  2. Go to Configurations → System Settings.
  3. Select the Products/Services section.

  4. Click Create a New Group.

  5. Fill in the fields. Required fields are marked with asterisks.
    • Product Group Name* — the name of the service group under which it will be displayed in the WHMCS client area. For example, "Ispmanager modules".
    • URL — a link to the group in the WHMCS client area. If hidden, the group will be accessible via the specified link.
    • Product Group Headline — the title under which the group will be displayed in the WHMCS client area. For example, "Enhanced Solutions for Server Management"
    • Product Group Tagline — the subtitle under which the group will be displayed in the WHMCS client area. For example, "LiteSpeed ​​web server, site protection tools Bitninja and DDoS-Guard and more"

    • Group Features — features available to the customer when ordering any service from the group.

    • Order Form Template — an order page template. The template becomes available for selection when editing a group after it's created.
      • Use System Default (Standard Cart) — use the standard order page.
      • Use Specific Template — select a different order page for the service.
    • Available Payment Gateways — select available payment gateways.
    • Hidden — check the box to hide the service group from the WHMCS client area. The group will only be accessible via a direct link.
  6. Click  Save Changes.

Services

For more information on service configuration, please refer to the official WHMCS documentation.

  1. Log in to WHMCS as an administrator at https://YOUR_DOMAIN/admin.
  2. Go to Configurations → System Settings.
  3. Select the Products/Services section.
  4. Click Create a New Product.
  5. Fill in the fields. Required fields are marked with asterisks.
    • Product Type* — select Other
    • Product Group* — service group
    • Product Name* — service name under which it will be displayed in the WHMCS client area
    • URL — a link to the service in the WHMCS client area. If hidden, the group will be accessible via the specified link.
    • Module — select "ispmanager NOC"
    • Create as Hidden:
      • ON — the service will be hidden from the WHMCS client area and accessible only via a direct link
      • OFF — the service will appear in the WHMCS client area immediately after creation
  6. Click Continue.

  7. Configure the remaining service settings. Required fields are marked with asterisks.

    Details
    • Product Tagline — the slogan with which the service will be displayed as a recommended feature in the WHMCS client area when ordering another service. For example, "Protect your server against attacks" when recommending the BitNinja module.
    • Product Short Description — a short description with which the service will be displayed as a recommended feature in the WHMCS client area when ordering another service. For example, "BitNinja protects server against SQL injections, utbound spam attacks, cross-site scripting, viruses, and multiple connections"
    • Product Description — the description with which the service will be displayed on the order page, for example, a list of features.

    • Product Color — the theme color with which the service will be displayed as a recommended feature in the WHMCS client area.
      For a service to be displayed as a recommended feature when ordering another service, it must be added as a recommended feature in the other service's settings on the Cross-sells tab.

    • Welcome Email — a welcome email template that will be automatically sent to the customer upon service activation.

      • None — the email will not be sent automatically.
      • Other Product/Service Welcome Email — the default template "Other Product/Service Welcome Email" will be used.

      Editing the default template and creating your own templates is available in Configuration → System Settings → Email Templates.

      Example

      To ensure that license information is sent to customers upon purchase of the BitNinja module, use the following variables in the welcome email template:

      • {$service_custom_field_bitninjaemail} — email for BitNinja authorization
      • {$service_custom_field_bitninjapassword} — password for BitNinja authorization
      • {$service_custom_field_bitninjakey} — BitNinja license key
    • Require Domain — leave blank.
    • Stock Control — check this box to limit the number of services available for ordering and enter the available quantity in the field. Once this quantity is reached, the service will no longer be available for ordering.
    • Apply Tax — add a tax to the service price. To configure taxes, go to Configuration → System Settings → Tax Configuration.
    • Featured — check this box to display the service as the most popular on the order page. Not available for all order page templates.
    • Hidden — check this box to hide the service from the WHMCS client area. The service will be available for ordering via a direct link.
    • Retired — check this box to make the service unavailable for ordering from either the WHMCS client or administrative areas, including via a direct link.
    Pricing

    • Payment Type:

      The service is available free of charge.

      The service will be available for a one-time payment.

      Check the Enable box next to the EUR currency to activate pricing in that currency and specify:

      • Setup Fee — the cost of the service
      • Price — a one-time fee for opening the service

      The service will be available on a subscription basis.

      Use the "Monthly," "Quarterly," and "Semi-Annually" and "Annually" billing periods. Selecting other options of billing periods will result in an error when ordering a license.

      Check the Enable box next to the desired payment period to activate that billing period:

      • One Time/Monthly
      • Quarterly
      • Semi-Annually
      • Annually

      For every active period specify:

      • Setup Fee — the cost of the service
      • Price — a one-time fee for opening the service

      For trial module tariff plans, use the "Free" payment type.

    • Allow multiple quantities — allow ordering multiple services of this type:
      • No — do not allow
      • Yes - Multiple services — when ordering multiple services, each service will be processed as a separate order.
      • Yes - Scaling service — when ordering multiple services, all services will be processed as a single order with a price equal to the service price multiplied by the number of services.
    • Recurring Cycles Limit — the number of times a service with the "Recurring" payment type selected will renew. Once this limit is reached, the customer's service will be automatically canceled. If the value is 0, the service will renew indefinitely until manually canceled.
    • Auto terminate/Fixed term — the number of days after which the service will be automatically canceled.
    • Termination email — a template for the email that will be automatically sent to the client upon automatic cancellation of the service if the Auto terminate/Fixed term parameter is configured. Creating and editing templates is available in the Configuration → System Settings → Email Templates section.
    • Pro-rata billing — check the box to enable prorated payment. In this case, the first payment when ordering a service will be calculated from the order date to the next recurring billing date, and the recurring billing date will be the same for all clients. Parameters:
      • Prorata date — day of the month of the recurring billing

      • Charge next month — the day of the month after which the payment for the next billing period will be added to the first payment. For example, if you set this value to 20, for orders placed after the 20th, the first payment will include the remainder of the month plus the entire next billing period. If you leave this value at 0, the next billing period will always be included in the first payment. If you set this value to 32, this will never be the case.

        Example

        A monthly billing period is selected for the hosting service, prorated payment is enabled, recurring charges are set for the 1st of the month, and the Charge Next Month parameter is set to 20.

        The client orders the hosting service on January 22.

        Their first payment will cover the remainder of January and all of February. The next invoice will be issued on March 1.

    • On-Demand Renewals* — early service renewal:
      • Use System Default — use the global settings specified in the Ordering tab under Configuration → System Settings → General Settings
      • Use Product-Specific Configuration — override the global settings for the service
      • Check to allow clients to place renewal orders early — check the box to allow clients to create renewal orders and specify the maximum number of days before the due date that clients can order renewals for each billing period. To disable early renewals for a specific period, specify 0.
    Module Settings
    • Server Group* — the server or group of ispmanager servers. Select a group from the list or None if the default server will be used for the service.

    • Product ID* — enter the ID of the desired ispmanager plan.

      How to find the ispmanager tariff ID

      To ensure the ID list is displayed correctly, set the server that will be used to provide the service as the default server.

      1. Go to Configurations → Apps & Integrations.
      2. Search "ispmanager."
      3. Select the ispmanager NOC partner module from the list.

      4. In the form that opens, click Use app. A list of licenses with IDs will open. The module IDs will be listed in the "ispmanager modules" section, while IDs of third-party licenses will be listed ib the in the "Other software" section, in the "ID" column.

    • Admin phone — leave the field blank.

    Set up automatization options:

    • Automatically setup the product as soon as an order is placed
    • Automatically setup the product as soon as the first payment is received
    • Automatically setup the product when you manually accept a pending order
    • Do not automatically setup this product
    Custom Fields

    Custom fields allow you to retrieve and store information about clients and services in the WHMCS administrative and client areas, such as the ispmanager license ID for which the module is ordered or the client's domain name.

    For ispmanager modules, the following fields are automatically created:

    • ip|Server IP address — the client's server IP address. By default, this field is prompted for the client to fill out when ordering BitNinja as a separate license.
    • licname|License name — the license name. By default, this field is prompted for the client to fill out when ordering BitNinja as a separate license.
    • item|ID of the ispmanager license for which the module is purchased — the ID of the ispmanager license which the module is being ordered for. By default, this field is required when ordering BitNinja as an ispmanager module.
    • bitninja_email|BitNinja Email — the client's email address for authorization in BitNinja. By default, this field is prompted for the client to fill out when ordering. If left blank, the email address will be generated automatically.
    • bitninjakey|BitNinja key — the BitNinja license key. The key is generated automatically and is available for viewing in the WHMCS client area.
    • bitninja_password|BitNinja password — the client password for logging into BitNinja.
    • order_id|Order ID — field for the order ID. The ID is automatically generated by ispmanager and displayed in your ispmanager account.
    • item|ID of the ispmanager license for which the module is purchased — the ID of the ispmanager license which the module is being ordered for. By default, this field is required when ordering BitNinja as an ispmanager module.
    • domain|Domain name — the client's domain name which DDos-Guard protection will be configured for. By default, this field is prompted for the client to fill out when ordering.
    • target_ip|Resource IP address — the client's server IP address. By default, this field is prompted for the client to fill out when ordering.
    • order_id|Order ID — field for the order ID. The ID is automatically generated by ispmanager and displayed in your ispmanager account.
    • item|ID of the ispmanager license for which the module is purchased — the ID of the ispmanager license which the module is being ordered for. By default, this field is required when ordering BitNinja as an ispmanager module.
    • order_id|Order ID — field for the order ID. The ID is automatically generated by ispmanager and displayed in your ispmanager account.
    • ip|Server IP address — the client's server IP address. By default, this field is prompted for the client to fill out when ordering BitNinja as a separate license.
    • licname|License name — the license name. By default, this field is prompted for the client to fill out when ordering BitNinja as a separate license.
    • item|ID of the ispmanager license for which the module is purchased — the ID of the ispmanager license which the module is being ordered for. By default, this field is required when ordering BitNinja as an ispmanager module.
    • order_id|Order ID — field for the order ID. The ID is automatically generated by ispmanager and displayed in your ispmanager account.

    To add a custom field, specify its parameters in the Add New Custom Field block:

    • Field Name
    • Display Order — the field display order. By default, fields are displayed in the order they are added.
    • Field Type:
      • Text Area
      • Text Box
      • Link/URL
      • Password
      • Drop Down
      • Checkbox
    • Description — field description for the client.
    • Validation — a regular expression for validating the entered value.
    • Select Options — specify options for the drop-down list field, separated by commas.
    • Admin Only — check the box to hide the field from the WHMCS client area. The field will only be accessible to the WHMCS administrator.
    • Required Field — check this box to make the field required.
    • Show on Order Form — check this box to display the field on the service order page.
    • Show on Invoice — check this box to display the field on invoices.

    To save the field and add a new one, click Save Changes.

    Configurable options

    Leave these fields unchanged.

    Upgrades

    Upgrades and downgrades are not supported for modules. Leave the fields unchanged.

    Free Domain

    Leave these fields unchanged.

    Cross-sells

    Recommended products and services will be offered to the customer when ordering the current service.

    To add a product or service to the recommended list, select it from the Product Cross-sells list and click Save Changes.

    Recommendations can be activated and configured in Configuration → System Settings → General Settings on the Ordering tab.

    Other
    • Custom Affiliate Payout — affiliate payouts:
      • Use Default — use default payouts.
      • Percentage — pay a percentage of the cost of services ordered by the referred client.
      • Fixed Amount — pay a fixed amount.
      • No Commission — do not pay affiliate payouts.
    • Affiliate Pay Amount — the affiliate payout percentage or amount. By default, the amount will be paid regularly. To make the payment a one-time payment, check the One Time Payout box.
    • Subdomain Options — leave this field blank.
    • Associated Downloads — leave this field blank.
    • Overages Billing — leave this field blank.
    Links
    • Direct Shopping Cart Link — a direct link to the shopping cart with the added service
    • Direct Shopping Cart Link Specifying Template — a direct link to the shopping cart with an added service and a custom order page template
    • Direct Shopping Cart Link Including Domain — a direct link to the shopping cart with an added service, to the domain selection form
    • Product Group Cart Link — a direct link to a group of services
    • Product URLs — a direct link to the service
  8. Click Save Changes.
  9. Create a separate service for each tariff plan.

Test service order

If the service was created correctly, it will be available for ordering in the WHMCS client area. To verify:

  1. Log in to WHMCS using a test client account at https://YOUR_DOMAIN/index.php or create a new account.

    How to create a test client account in WHMCS

    1. Click Account → Register.

    2. Fill in the fields. Required fields are marked with asterisks. Data may be fictitious.
      • Personal Information:
        • First Name* — name of the test client
        • Last Name* — last name of the test  client
        • Email Address* — email of the test client
        • Phone Number — phone number of the test client
      • Billing Address:
        • Company Name — place of work
        • Street Address
        • Street Address 2
        • City
        • State
        • Postcode
        • Select a country from the list
      • Additional Information:
        • Select a currency from the list, such as USD or EUR
      • Account Security:
        • Password*
        • Confirm Password*
        • Generate Password
          • Password Length
          • Generated Password
          • Generate New Password
          • Copy
          • Copy to Clipboard and Insert
    3. Click Register.
  2. Go to Services → Order New Services.
  3. Select a service group from the Categories menu. The service you created will be displayed on the page.

Available actions

  1. Log in to WHMCS as an administrator at https://YOUR_DOMAIN/admin.
  2. Go to Orders → List All Orders.
  3. Select the required order from the list.
  4. Click Product/Service in the Order Items table.
  5. Execute the required action on the form that opens:
    • Module Commands:
      • Create — order a module
      • Renew — renew a module
      • Terminate — disable a module
      • Change params — sync license data with those specified in custom fields

      • Sync — sync Status, Termination Date, and BitNinja E-mail with data from your ispmanager account

  6. Save the changes.
  1. Log in to WHMCS as an administrator at https://YOUR_DOMAIN/index.php.
  2. Go to Services → My services.
  3. Select the required service from the list.

  4. On the page that opens, goto the Additional Information tab to see the information about thr service:

In this article