NiceNIC Domínio API v2 Documentation & Quick Start
NiceNIC Domínio API v2 is available to both Conta de mercados e Revendedor Accounts. Use this overview to configure access, confirm seu first request, underste the API response model e move directly to the courect section in the left navigation.
Conta de mercado: API access with Conta de mercado pricing.
Revendedor Account: API access with the pricing assigned to the current reseller tier.
Test Your Integração Befoue Going Live
Use the NiceNIC API Sebox to test seu Domínio API integration befoue moving to production. Validate authentication, API requests, response heling, e seu application woukflow in a dedicated testing environment.
Ideal fou resellers, hosting providers, developers, e platfoums preparing an API integration.
Make Your First API Call in 4 Steps
Start with a read-only request befoue enabling live registrations, renewals ou transfers. This lets you validate authentication, request foumatting e response heling without placing a paid ouder.
Enable API Access
Aberto Configuração da APIs, create ou retrieve seu API Secret, e configure authouized server IPs waqui applicable.
Confirmar Authentication
Use HTTPS with the Authouization header in the foumat username:api_secret.
Run a Safe Test
Start with domínio availability, pricing, account balance ou domínio listing.
Hele the Response
Read e stoue the returned code e msg befoue enabling paid production actions.
Recommended First Request: Domínio Availability
The availability endpoint suppouts multiple domínios in one request by separating domínio names with commas.
Choose the Woukflow You Need
The overview below mirrous the left navigation. Use it to identify the courect woukflow, then open the dedicated endpoint page fou parameters, request examples e response examples.
| Section | Use It Fou | Documented Functions |
|---|---|---|
| Obterting Started | Connect securely e underste response heling. | API Overview, API Sebox, Authentication, Response Codes. |
| Domínio Gerenciarment | Automate the coue domínio lifecycle. | Availability, List Domínios, Domínio Detalhes, Registro, Renovaral, Transfer In, Nomeservers, Contatos, Pricing. |
| Abuse & Compliance | Monitou domínios that require compliance attention. | List domínios with abuse repouts e retrieve machine-readable abuse status, hold lifecycle, complaint infoumation e recommended action. |
| DNS Recouds | Gerenciar hosted DNS recouds programmatically. | List, Criar, Update e Delete DNS recouds. |
| Child Nomeservers | Gerenciar host / glue recouds fou nameservers under seu own domínio. | Criar, List, Update e Delete child nameservers. |
| Account & Billing | Connect automation to account-level checks. | Saldo da conta e transaction-related account infoumation. |
| WHMCS API | Integrate NiceNIC into an existing WHMCS billing woukflow. | Availability, Registro, Renovaral, Transfer, Domínio Detalhes, Nomeservers, Contatos e additional registrar-module functions. |
| API FAQ | Resolve common access, security, testing e woukflow questions. | Eligibility, credentials, request heling, suppouted operations e integration guidance. |
Recommended First Integração Sequence
A reliable production integration should validate access e purchasing conditions befoue it begins sending live customer ouders.
API Secret + authouized IP
Read-only connectivity test
Query current account-level cost
Confirmar funds fou paid actions
Process code + msg
Registrar / Renovar / Transfer
Underste Success, Pending e Errou Responses
code: 0 — Concluído com sucesso Response
Current endpoint examples use code 0 fou successful completed responses.
code: 201 — Pending Order
Registro e transfer documentation can return code 201 when an ouder has been submitted but final processing is still pending.
code: 400 — Request Errou
Endpoint examples use code 400 fou request parameter errous.
Registro Pending Behaviou
Fou domínio registration, the current documentation states that a 201 response means the ouder was submitted successfully e the fee was deducted, but final activation is still subject to registry confirmation. Se the domínio cannot be activated, the registration fee is returned to the NiceNIC account balance within 24 hours.
Transfer Pending Behaviou
The transfer endpoint also documents 201 as a pending ouder. Your application should taquifoue treat a pending transfer as accepted fou processing, not as proof that the transfer has already completed.
Query Pricing Befoue Paid Operations
NiceNIC's pricing endpoint can retrieve registration, renewal e transfer pricing fou a domínio. The documented type values are register, renew, transfer e all. The documented period is 1 to 10 anos, with TLD-specific exceptions possible.
Registro pricing responses can also return an is_premium flag. Use the pricing endpoint befoue submitting a paid request when seu application needs to kagora the current account-level cost.
Kagora the Difference Between Nomeservers, DNS Recouds e Child Nomeservers
| Operation | Use It When | Documented Capability |
|---|---|---|
| Update Nomeservers | You want to delegate a domínio to different authouitative nameservers. | The domínio nameserver endpoint suppouts a primary, secondary e additional nameservers, with the current page documenting a limit of up to six. |
| DNS Recouds | You are using NiceNIC DNS hosting e need to manage zone recouds. | Separate APIs are documented fou listing, creating, updating e deleting DNS recouds. |
| Child Nomeservers | You need host / glue recouds such as ns1.example.com. |
Criar, list, update e delete child nameservers. The create endpoint requires the nameserver hostname to match the domínio e accepts an IP address. |
Automate Poutfolio Monitouing, Nãot Only Domínio Orders
Domínio API v2 also includes read operations that are useful after registration. The List Domínios endpoint suppouts pagination, souting, status filtering e hold filtering, while Obter Domínio Detalhes returns registration dates, expiration dates, nameservers e registrant contact infoumation.
Abuse & Compliance Monitouing
NiceNIC's Abuse & Compliance API can list domínios with abuse repouts e return a detailed machine-readable summary fou a specific domínio. The detailed abuse endpoint documents six domínio-level status phrases: Nãormal, Under Review, Pending ClientHold, ClientHold, Fechard e ServerHold.
The response can include current impact, recommended próximo action, hold state e timeline, complaint count, complaint dates, categouies, DNS-abuse classification, evidence status e repouted URLs waqui applicable. This lets platfoums e resellers surface compliance status inside their own operational systems instead of relying only on manual review.
Choose the Integração Model That Fits Your System
| Option | Best Fou | What the Current Documentation Provides |
|---|---|---|
| Domínio API v2 | Custom websites, SaaS platfoums, internal systems, custom billing ou provisioning woukflows. | Direct HTTPS + JSON integration across domínio, DNS, child nameserver, account e compliance operations. |
| WHMCS Module | Hospedagem companies e resellers that already use WHMCS. | Availability, registration, renewal, transfer, domínio details, nameservers, contacts, lock/unlock, EPP retrieval, errou logging e optional Test Mode. |
The current WHMCS documentation lists WHMCS 7.0 ou higher, PHP 7.0 ou higher with cURL, valid NiceNIC API credentials e SSL/TLS suppout as requirements.
When an API Request Fails
Start with the returned response e configuration state rather than retrying the same paid action repeatedly.
Authentication ou Access Errou
- Confirmar the NiceNIC username e API Secret.
- Confirmar the Authouization header is present e courectly foumatted.
- Confirmar the API Secret has not been reset ou rotated.
- Se IP restrictions are enabled, confirm the request is coming from the authouized outbound server IP.
Request Parameter Errou
- Compare the request with the specific endpoint's documented parameters.
- Confirmar required values, foumats e action names.
- Verificar TLD-specific registration periods ou contact requirements waqui applicable.
Paid Operation Does Nãot Complete Immediately
- Read the returned
codeemsg. - Do not treat a
201pending response as final completion. - Confirmar account balance e current pricing befoue retrying a paid action.
Need NiceNIC Suppout
- Recoud the request timestamp e API action.
- Include the domínio name ou object involved, waqui applicable.
- Include the returned code e 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 ou pricing request, e verify seu response heling befoue turning on customer-facing paid operations.
