Module and release scope
This guide covers Name.com Registrar 1.0.0, Extension API 1, from the reviewed product source. Its declared core range is 1.3.6–1.3.99. Use the matching released core and signed provider package; a version label alone does not install the required contracts. Source availability does not mean the module is bundled in every currently downloadable product, installed on your server, enabled or certified for your merchant/server account. Nothing in this guide enables a provider or changes your existing connections.
Open System → Domain registrars (newer source may group these as Payments, Domain services or Hosting services). Install the reviewed signed package through Modules & addons or the integration workspace's Install tab, enable the module separately, add an account/connection, save its own credentials, run its stated Test and explicitly enable the connection. Saving or retesting disables the connection until you enable it again. Start with the provider's test environment where supported; otherwise use an isolated account or server.
Exact connection fields
These are the fields declared by this module. Secret values are entered privately and encrypted by the application. Defaults are configuration hints, not approved live merchant settings. Internal fields are populated by the module and are not operator-editable.
| Key / label | Type | Required | Default / guidance |
|---|---|---|---|
environment — Environment |
select | Yes | Default: "sandbox" Choices: sandbox = Development sandbox, live = Live |
username — API username |
text | Yes | Use the account-specific value described below. |
api_token — API token |
secret | Yes | Use the account-specific value described below. |
allow_writes — Allow domain purchases and changes |
boolean | No | Default: false |
allow_automated_renewals — Allow paid-invoice automated renewals |
boolean | No | Default: false |
This module uses the current Name.com Core API at /core/v1, rather than the older v4 API. Installation leaves it disabled; domain writes and automated renewals also default to off. Enable the module, create a connection, save credentials and run Test before assigning it to domains.
Credentials and environments
Obtain API access for the Name.com account and generate its API token. Enter API username and token in the connection. Use a separate development account and token in the sandbox first. The fixed endpoints are https://api.dev.name.com/core/v1 and https://api.name.com/core/v1. Authentication uses HTTP Basic with username:token. Test reads /accountinfo/balance and never purchases a domain. Fund the account using Name.com's approved funding methods before enabling live purchases.
API transports use HTTPS, bounded timeouts and response size, no redirects and no automatic retry. This module uses API synchronization for state; it does not require a webhook URL. Optional Name.com webhook integrations are separate from this package.
Supported operations
- Live registration availability using
POST /domains:checkAvailability, restricted topurchaseType: registration. - Standard registration, transfer in and renewal, with fresh
/domains/{name}:getPricingpreflight and premium rejection. - Domain information/synchronization, custom nameservers, lock/unlock and EPP retrieval.
Registration requires the actual customer contact and at least two distinct nameservers. Complete contact values are mapped to all four WHOIS roles; merchant account contacts cannot silently replace missing customer details. Supply first and last name, email, street, city, state, postcode, ISO country and international phone. The organization field identifies legal ownership; ensure the customer's saved organization is correct. Registration explicitly disables registrar auto-renewal so customer invoices control renewals.
The ordered integer term is sent explicitly; Name.com enforces the TLD's permitted term (commonly 1–10 years, with a two-year minimum for .ai). Registry-specific extra values can be supplied in tld_requirements through the domain tool's optional provider options. Check Name.com's TLD requirement endpoint for the exact keys and values; this module does not invent eligibility or accept trademark claims. Registry-premium, aftermarket, expired acquisition and backorder purchases are held for separate review, rather than registering them at a standard retail price.
Transfer in accepts one year and requires auth_code; all intended customer contacts are provided explicitly. The successful response is an accepted transfer, not an active domain. Wait for transfer completion and synchronize before activation. If submitted contacts cannot be applied at completion, correct them in Name.com and synchronize again.
Confirmation and diagnostics
A purchase receipt alone does not activate a service. Registration reads the exact owned domain back and checks its registry expiry covers the full requested term, with matching registrant fields and nameservers. Hold/pending flags and an explicitly unverified registrant remain pending. Renewals read remote expiry before submission and require the complete purchased extension afterward. A stale local expiry prevents another renewal purchase. Write access and the separate automated-renewal switch are both required for automated renewal.
A timeout, malformed response or incomplete confirmation retains submitted uncertainty. Review the Name.com order and synchronize before retrying; the product prevents a second automatic purchase. Safe diagnostics expose useful provider errors while redacting API credentials, generated Basic authentication, contact fields and authorization codes.