NiceNIC Домен API v2 Documentation & Quick Start
NiceNIC Домен API v2 is available to both Нарықтық шотs және Өкіл Accounts. Use this overview to configure access, confirm сіздің first request, understжәне the API response model және move directly to the cнемесеrect section in the left navigation.
Нарықтық шот: API access with Нарықтық шот pricing.
Өкіл Account: API access with the pricing assigned to the current reseller tier.
Test Your Интеграция Befнемесеe Going Live
Use the NiceNIC API Sжәнеbox to test сіздің Домен API integration befнемесеe moving to production. Validate authentication, API requests, response hжәнеling, және сіздің application wнемесеkflow in a dedicated testing environment.
Ideal fнемесе resellers, hosting providers, developers, және platfнемесеms preparing an API integration.
Make Your First API Call in 4 Steps
Start with a read-only request befнемесеe enabling live registrations, renewals немесе transfers. This lets you validate authentication, request fнемесеmatting және response hжәнеling without placing a paid немесеder.
Enable API Access
Ашу API баптауларыs, create немесе retrieve сіздің API Secret, және configure authнемесеized server IPs wмұнда applicable.
Растау Authentication
Use HTTPS with the Authнемесеization header in the fнемесеmat username:api_secret.
Run a Safe Test
Start with домен availability, pricing, account balance немесе домен listing.
Hжәнеle the Response
Read және stнемесеe the returned code және msg befнемесеe enabling paid production actions.
Recommended First Request: Домен Availability
The availability endpoint suppнемесеts multiple доменs in one request by separating домен names with commas.
Choose the Wнемесеkflow You Need
The overview below mirrнемесеs the left navigation. Use it to identify the cнемесеrect wнемесеkflow, then open the dedicated endpoint page fнемесе parameters, request examples және response examples.
| Section | Use It Fнемесе | Documented Functions |
|---|---|---|
| Алуting Started | Connect securely және understжәне response hжәнеling. | API Overview, API Sжәнеbox, Authentication, Response Codes. |
| Домен Басқаруment | Automate the cнемесеe домен lifecycle. | Availability, List Домендер, Домен Толығырақ, Тіркеу, Жаңартуal, Transfer In, Атыservers, Байланысs, Pricing. |
| Abuse & Compliance | Monitнемесе доменs that require compliance attention. | List доменs with abuse repнемесеts және retrieve machine-readable abuse status, hold lifecycle, complaint infнемесеmation және recommended action. |
| DNS Recнемесеds | Басқару hosted DNS recнемесеds programmatically. | List, Жасау, Update және Delete DNS recнемесеds. |
| Child Атыservers | Басқару host / glue recнемесеds fнемесе nameservers under сіздің own домен. | Жасау, List, Update және Delete child nameservers. |
| Account & Billing | Connect automation to account-level checks. | Есепшот қалдығы және transaction-related account infнемесеmation. |
| WHMCS API | Integrate NiceNIC into an existing WHMCS billing wнемесеkflow. | Availability, Тіркеу, Жаңартуal, Transfer, Домен Толығырақ, Атыservers, Байланысs және additional registrar-module functions. |
| API Жиі қойылатын сұрақтар | Resolve common access, security, testing және wнемесеkflow questions. | Eligibility, credentials, request hжәнеling, suppнемесеted operations және integration guidance. |
Recommended First Интеграция Sequence
A reliable production integration should validate access және purchasing conditions befнемесеe it begins sending live customer немесеders.
API Secret + authнемесеized IP
Read-only connectivity test
Query current account-level cost
Растау funds fнемесе paid actions
Process code + msg
Тіркелу / Жаңарту / Transfer
Understжәне Success, Pending және Errнемесе Responses
code: 0 — Сәтті Response
Current endpoint examples use code 0 fнемесе successful completed responses.
code: 201 — Pending Order
Тіркеу және transfer documentation can return code 201 when an немесеder has been submitted but final processing is still pending.
code: 400 — Request Errнемесе
Endpoint examples use code 400 fнемесе request parameter errнемесеs.
Тіркеу Pending Behaviнемесе
Fнемесе домен registration, the current documentation states that a 201 response means the немесеder was submitted successfully және the fee was deducted, but final activation is still subject to registry confirmation. Егер the домен cannot be activated, the registration fee is returned to the NiceNIC account balance within 24 hours.
Transfer Pending Behaviнемесе
The transfer endpoint also documents 201 as a pending немесеder. Your application should tмұндаfнемесеe treat a pending transfer as accepted fнемесе processing, not as proof that the transfer has already completed.
Query Pricing Befнемесеe Paid Operations
NiceNIC's pricing endpoint can retrieve registration, renewal және transfer pricing fнемесе a домен. The documented type values are register, renew, transfer және all. The documented period is 1 to 10 жылдар, with TLD-specific exceptions possible.
Тіркеу pricing responses can also return an is_premium flag. Use the pricing endpoint befнемесеe submitting a paid request when сіздің application needs to kқазір the current account-level cost.
Kқазір the Difference Between Атыservers, DNS Recнемесеds және Child Атыservers
| Operation | Use It When | Documented Capability |
|---|---|---|
| Update Атыservers | You want to delegate a домен to different authнемесеitative nameservers. | The домен nameserver endpoint suppнемесеts a primary, secondary және additional nameservers, with the current page documenting a limit of up to six. |
| DNS Recнемесеds | You are using NiceNIC DNS hosting және need to manage zone recнемесеds. | Separate APIs are documented fнемесе listing, creating, updating және deleting DNS recнемесеds. |
| Child Атыservers | You need host / glue recнемесеds such as ns1.example.com. |
Жасау, list, update және delete child nameservers. The create endpoint requires the nameserver hostname to match the домен және accepts an IP address. |
Automate Pнемесеtfolio Monitнемесеing, Жоқt Only Домен Orders
Домен API v2 also includes read operations that are useful after registration. The List Домендер endpoint suppнемесеts pagination, sнемесеting, status filtering және hold filtering, while Алу Домен Толығырақ returns registration dates, expiration dates, nameservers және registrant contact infнемесеmation.
Abuse & Compliance Monitнемесеing
NiceNIC's Abuse & Compliance API can list доменs with abuse repнемесеts және return a detailed machine-readable summary fнемесе a specific домен. The detailed abuse endpoint documents six домен-level status phrases: Жоқrmal, Under Review, Pending ClientHold, ClientHold, Жабуd және ServerHold.
The response can include current impact, recommended алға action, hold state және timeline, complaint count, complaint dates, categнемесеies, DNS-abuse classification, evidence status және repнемесеted URLs wмұнда applicable. This lets platfнемесеms және resellers surface compliance status inside their own operational systems instead of relying only on manual review.
Choose the Интеграция Model That Fits Your System
| Option | Best Fнемесе | What the Current Documentation Provides |
|---|---|---|
| Домен API v2 | Custom websites, SaaS platfнемесеms, internal systems, custom billing немесе provisioning wнемесеkflows. | Direct HTTPS + JSON integration across домен, DNS, child nameserver, account және compliance operations. |
| WHMCS Module | Хостинг companies және resellers that already use WHMCS. | Availability, registration, renewal, transfer, домен details, nameservers, contacts, lock/unlock, EPP retrieval, errнемесе logging және optional Test Mode. |
The current WHMCS documentation lists WHMCS 7.0 немесе higher, PHP 7.0 немесе higher with cURL, valid NiceNIC API credentials және SSL/TLS suppнемесеt as requirements.
When an API Request Fails
Start with the returned response және configuration state rather than retrying the same paid action repeatedly.
Authentication немесе Access Errнемесе
- Растау the NiceNIC username және API Secret.
- Растау the Authнемесеization header is present және cнемесеrectly fнемесеmatted.
- Растау the API Secret has not been reset немесе rotated.
- Егер IP restrictions are enabled, confirm the request is coming from the authнемесеized outbound server IP.
Request Parameter Errнемесе
- Compare the request with the specific endpoint's documented parameters.
- Растау required values, fнемесеmats және action names.
- Тексеру TLD-specific registration periods немесе contact requirements wмұнда applicable.
Paid Operation Does Жоқt Complete Immediately
- Read the returned
codeжәнеmsg. - Do not treat a
201pending response as final completion. - Растау account balance және current pricing befнемесеe retrying a paid action.
Need NiceNIC Suppнемесеt
- Recнемесеd the request timestamp және API action.
- Include the домен name немесе object involved, wмұнда applicable.
- Include the returned code және message.
- Share non-sensitive parameters only; never post the full API Secret in a ticket.
Start with a Safe Test Request
Enable API access, confirm authentication, run an availability немесе pricing request, және verify сіздің response hжәнеling befнемесеe turning on customer-facing paid operations.
