# DomainNameAPI

https://docs.wisecp.com/en/domainnameapi

Connect your DomainNameAPI reseller account to register, transfer and renew domains from WISECP without manual work at the provider.

## Accessing the Screen

Open **Products → Domains → Domain Name Registrars → All Modules → DomainNameAPI**: `{admin}/module/registrars?module=DomainNameAPI`.

DomainNameAPI is a marketplace module, and new WISECP 5 installation packages include it. If its card is missing from **All Modules**, follow **Installing the Module** below. New versions come from the marketplace; WISECP updates do not change the module.

## What Is on the Screen

A status strip opens the page. **Disabled** means no extension is assigned to DomainNameAPI yet; saving its settings does not enable it. **Module Settings** holds the account settings. **Import** lists the active domains in your DomainNameAPI account, and **Import Extensions** lists extensions with their costs.

### Preparing the Provider Account

1. Open a reseller account at [DomainNameAPI](https://www.domainnameapi.com/). Registrations, transfers and renewals are paid from its balance.
2. In the DomainNameAPI panel, open **API Settings** and copy your **Reseller ID** and **API Key**. Your panel login e-mail does not work here.
3. For trials, ask DomainNameAPI for a test account. **Test Mode** sends requests to its test (OTE) environment.

## Settings

- ****Reseller ID****: Required; initially empty. The ID shown under API Settings, in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format.
- ****API Key****: Required; initially empty. It is saved encrypted and shown as a mask. Leave the mask untouched to keep the saved key.
- ****Test Mode****: Off by default. Uses the DomainNameAPI test environment, so enter test credentials with it.
- ****Telemetry & Error Reporting****: Off by default. When on, error codes and messages, the API endpoint, duration, versions and Reseller ID go to DomainNameAPI. Contact details, domain names and server details are not sent.
- ****Update pricing automatically****: Off by default. With **Auto-Update** on under Products → Domains, costs refresh daily. Auto-priced extensions assigned here get new selling prices from your profit margin.
- ****Excluded Extensions****: Optional; initially empty. Enter a comma-separated list, for example com.tr,org.tr. These extensions are never imported or updated.
- ****Balance****: Appears after credentials are saved. Shows your account balance per currency, or the error DomainNameAPI returned.
- ****Default Nameservers****: Four initially empty fields; the first two are marked required. Enter the nameservers your domains use by default.
- ****Cost Currency****: Check the initial selection. It applies only to costs DomainNameAPI sends without a currency.

## Tasks

### Installing the Module

Needed only when DomainNameAPI is not listed under **All Modules**.

1. On **Domain Name Registrars**, open **Recommended Modules** and click **Get Module** on the DomainNameAPI card. The marketplace listing opens in a new tab.
2. Click **Sign in to download** and sign in. Downloading needs an active WISECP license on your account.
3. Click **Download**, pick this system’s license in **Which license is this for?** and click **Download**. The ZIP package is saved.
4. In the panel, click **Upload New Module** beside the page title and choose the ZIP package. After installation, the card shows **Configure**.

### Connecting and Testing

1. In **Module Settings**, enter **Reseller ID** and **API Key**. Turn on **Test Mode** only with test credentials.
2. Click **Test Connection** beside **Save Changes**. The test reads your reseller details without buying anything.
3. After a successful test, click **Save Changes**. **Balance** then shows your account balance.

### Enabling the Registrar

1. Click **Enable** in the status strip. The **Enable Registrar** window opens.
2. To bring extensions from DomainNameAPI, click **Import Extensions** under **Import From This Registrar**. To use extensions you already sell, choose a group under **Assign Existing Extensions** and click **Assign Extensions**.
3. The strip shows **Enabled** and the **Assigned Extensions** count. Searches, registrations, transfers and renewals for those extensions now go through DomainNameAPI.

Assigning keeps costs and selling prices. Domains already registered stay with their current registrar.

### Importing Extensions and Domains

1. Open **Import Extensions**, select extensions and click **Import**. New extensions are created inactive. Extensions already assigned here only get new prices; others move to DomainNameAPI.
2. Under **Products → Domains**, check selling prices and statuses before you sell.
3. To add domains already in your account, open **Import**, choose a customer for each domain and click **Import**.
4. Check each new service’s customer and expiry date. Import creates services in WISECP; it does not register or transfer domains.

### Registration, Transfer and Renewal

Registration needs the owner’s first name, e-mail, address, city, country, postcode and phone. If one is missing, the order stops and names the missing fields. For .tr domains, the customer profile needs the owner’s Turkish ID number, or the company’s tax office and tax number. Domains waiting for documents or approval stay in process and are checked again automatically. A repeated order does not register the same domain twice. Transfers need the EPP code from the current registrar. Renewals use the number of years ordered.

### Managing a Domain

Open the domain under **Orders → Services**. DomainNameAPI supports nameservers, child nameservers, WHOIS contacts, WHOIS privacy, the transfer lock and the EPP code. DNS record types: A, AAAA, ALIAS, CAA, CNAME, DS, MX, NAPTR, PTR, SRV, TLSA and TXT. Status and expiry dates are synchronized automatically. Customers manage their domains according to their permissions and active addons. DNSSEC, e-mail and URL forwarding, and expired domain recovery are not available through this module.

## Things to Consider

> **Charges to Your Balance**
> 
> Registrations, transfers and renewals are paid from your DomainNameAPI balance. Try these workflows with Test Mode and a test account before you sell. A connection test does not verify them.

> **No Effect Until Extensions Are Assigned**
> 
> Saved credentials alone change nothing in your sales. DomainNameAPI handles only the extensions assigned to it.

## Required Permissions

Module settings require **Domain Name Registrars** permission. **Enable**, extension assignment and price changes also require **Products → Edit**.

## Related Guides

- [Registrar Configuration](https://docs.wisecp.com/en/registrar-modules)
- [Module Management](https://docs.wisecp.com/en/module-management)
- [Domain Extensions](https://docs.wisecp.com/en/domain-extensions-and-pricing)
- [Service DNS Management](https://docs.wisecp.com/en/service-dns-management)
- [Service WHOIS Records](https://docs.wisecp.com/en/service-whois-records)