Skip to main content

Registrar Module Configuration

Once the module is installed, you need to activate it in WHMCS and enter your HostMyServers API credentials.

Activate the Module​

  1. Log in to the WHMCS administration
  2. Navigate to Setup → System → Registrar Modules
  3. Locate HostMyServers in the list
  4. Click Activate

The module is now active. A configuration form appears.

Connection Settings​

After activation, fill in the following fields:

API Key​

An API key generated from hostmyservers.fr/user/api. From this page, you can create a key, give it a name (e.g. WHMCS Production) and delete it at any time. Treat this key like a password: never share it and never commit it to a Git repository.

API Key Security

If you believe your API key has been compromised, delete it immediately from hostmyservers.fr/user/api and create a new one. Then update the key in the WHMCS module configuration.

For sandbox credentials, contact HostMyServers support.

Default Owner Contact​

This field defines the owner contact used by default when registering each domain. Two options are available:

Option 1 — Use the HostMyServers account profile

Check Use account owner (use_account_owner: true). The profile information associated with the API key (name, address, email, phone) is automatically used as the Owner contact.

Option 2 — Use an existing contact

Enter a contact identifier (contact_id) from your HostMyServers contact book. To retrieve the list of your available contacts, query the endpoint:

GET /domains/contacts

The response lists all your contacts with their id, which you can copy into this field.

When to use a contact_id?

Use a contact_id if you are registering domains on behalf of an entity different from your main profile (e.g. a separate company, a subsidiary). This allows you to have a consistent Owner without modifying your account information.

Testing the Connection​

After entering your credentials, click Save then click the Test Connection button. WHMCS will make a test call to the HostMyServers API and display the result:

  • Success: "Connection successful. Account balance: XX.XX €" — your configuration is operational
  • Authentication error: check your API identifier and key
  • Connection error: check that your server can reach the HostMyServers API (firewall, cURL enabled)

Advanced Settings​

Automatic Domain Synchronisation​

This setting enables periodic synchronisation of your domains' statuses and expiry dates. It is strongly recommended to leave it enabled to maintain consistency between WHMCS and HostMyServers.

Recommended value: Enabled

DNS Propagation Delay (in hours)​

Duration displayed to the client after a nameserver modification, indicating the estimated propagation delay. This has no technical impact.

Default value: 24

Show Balance in Dashboard​

If enabled, a widget displays your HostMyServers balance in the WHMCS administration dashboard.

Recommended value: Enabled (useful for anticipating account top-ups)

Summary​

Once the configuration is complete and the connection test is validated, your HostMyServers registrar module is ready. Proceed to the next step: extension management.