Guide to Integrating WHMCS

In order to integrate WHMCS with OneSaas you need to configure a dedicated API user for OneSaas to use.

Please also read the official WHMCS documentation on Administrators and Permissions.

  1. Create a Role Group “API”
  2. Create a user in WHMCS
  3. Configure API Access Restriction IPs
  4. Connect OneSaas to your WHMCS

1. Create a Role Group API

This is an optional step. You can jump directly to step two if you don’t want to create a dedicated role group.

  1. Open the Setup > Administration Roles screen and select Add New Role Group
    image
  2. Enter the name API Access
    image
  3. Uncheck all roles. Check API Access role (bottom-right corner of the screen)
    image
  4. Save the role

2. Create a user in WHMCS

  1. Open the Setup > Administrators screen and select Add New Administrator
    image
  2. Enter the following details (feel free to adjust them to your needs)
    • Administrator Role: API (if you created the API role in step 1 or Full Administrator otherwise)
    • First Name: OneSaas
    • Last Name: API
    • Email Address: user+whmcs@onesaas.com
    • User Name: user_whmcs
    • Password & Confirm Password: Enter a strong password. You can use our Strong Password Generator to generate a strong password
      image
  3. Save Changes

3. Configure API Access Restrictions IPs

  1. Open the Setup  > General Settings screen
  2. Select the Security Tab
  3. Enter the following IPs in the list of API Access Restrictions IP
    • 111.67.0.82
    • 111.67.0.83
    • 111.67.0.84
    • image

4. Connect OneSaas to your WHMCS

  1. On the OneSaas DashBoard select “New Connection” and then select WHMCS from the popup
    image
  2. Enter the connection details:
    • URL to the API of your WHMCS server
      • The URL to the API has to end with /includes/api.php
      • If your url to the admin site looks like: http://www.mysite.com/admin then the url to the API will look like http://www.mysite.com/includes/api.php
    • User Name and Password as configured in step 2
      image
    • Click Apply