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
Отворен Настройка на APIs, 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.
