Provider guides
Namecheap Domains: configuration and operations
Connect the Domain module to Namecheap availability, registration and renewal operations through its XML API.
On this page
Provider workflow
Connect the Domain module to Namecheap availability, registration and renewal operations through its XML API. The registrar key is namecheap-registrar, which is different from the package ID namecheap-domain. This package does not register a DNS-provider role.
Requirements
Agovena Core ^0.0.1. Enable Domain before this extension.
This extension is not marked production-ready. Validate its supported workflow in your own test environment before accepting customer orders.
Set up the package
Configure api_user, secret api_key, username, client_ip and sandbox. Sandbox defaults to true. Although the first four settings are optional in the manifest, the HTTP client rejects a request if any is blank. Select namecheap-registrar on the product and use provider_settings.years for the requested registration term.
Provider-specific boundaries
The client posts form data to https://api.sandbox.namecheap.com/xml.response or https://api.namecheap.com/xml.response. Its commands are namecheap.domains.check, namecheap.domains.create and namecheap.domains.renew. Domain input must be a fully qualified ASCII name. Use the provider-approved client IP and API access policy for the environment you are testing.
Begin with a sandbox availability check and verify that a missing response entry is treated as unavailable. For renewals, inspect both the returned success flag and the registrar account, because the adapter returns no expiry date. Do not sell automatic new registrations based on this configuration guide alone. The provider create contract requires contact data that is not present in the adapter payload. Do not put that personal data into arbitrary extra settings expecting it to be forwarded. Resolve the adapter contract first, then test registration, failure and renewal separately. 2
Configuration contract
| Field | Type | Required | Secret | Default |
|---|---|---|---|---|
api_user |
string |
No | No | Empty |
api_key |
string |
No | Yes | Empty |
username |
string |
No | No | Empty |
client_ip |
string |
No | No | Empty |
sandbox |
boolean |
No | No | true |
These are the declared manifest fields. A field marked optional may still be required by an API operation, as described above. Store secret values only in protected settings, never in product descriptions, URLs or shared examples. 1
Operation and failure handling
The adapter checks XML status and provider errors, then maps registration or renewal success to active or failed. It does not populate an expiry date from these responses. The current create request sends only DomainName and Years beyond authentication, while Namecheap documents required registrant contact fields. Treat new registration as incomplete until that contact contract is supplied and tested; saved credentials alone do not make this a production-ready registrar.