NiceNIC Domeen API v2 Documentation & Quick Start
NiceNIC Domeen API v2 is available to both Turu kontos ja Järelmüüja Accounts. Use this overview to configure access, confirm sinu first request, understja the API response model ja move directly to the cvõirect section in the left navigation.
Turu konto: API access with Turu konto pricing.
Järelmüüja Account: API access with the pricing assigned to the current reseller tier.
Test Your Integratsioon Befvõie Going Live
Use the NiceNIC API Sjabox to test sinu Domeen API integration befvõie moving to production. Validate authentication, API requests, response hjaling, ja sinu application wvõikflow in a dedicated testing environment.
Ideal fvõi resellers, hosting providers, developers, ja platfvõims preparing an API integration.
Make Your First API Call in 4 Steps
Start with a read-only request befvõie enabling live registrations, renewals või transfers. This lets you validate authentication, request fvõimatting ja response hjaling without placing a paid võider.
Enable API Access
Ava API seadistuss, create või retrieve sinu API Secret, ja configure authvõiized server IPs wsiin applicable.
Kinnita Authentication
Use HTTPS with the Authvõiization header in the fvõimat username:api_secret.
Run a Safe Test
Start with domeen availability, pricing, account balance või domeen listing.
Hjale the Response
Read ja stvõie the returned code ja msg befvõie enabling paid production actions.
Recommended First Request: Domeen Availability
The availability endpoint suppvõits multiple domeens in one request by separating domeen names with commas.
Choose the Wvõikflow You Need
The overview below mirrvõis the left navigation. Use it to identify the cvõirect wvõikflow, then open the dedicated endpoint page fvõi parameters, request examples ja response examples.
| Section | Use It Fvõi | Documented Functions |
|---|---|---|
| Hangiting Started | Connect securely ja understja response hjaling. | API Overview, API Sjabox, Authentication, Response Codes. |
| Domeen Haldament | Automate the cvõie domeen lifecycle. | Availability, List Domeenid, Domeen Detailid, Registreerimine, Uuendaal, Transfer In, Nimiservers, Kontakts, Pricing. |
| Abuse & Compliance | Monitvõi domeens that require compliance attention. | List domeens with abuse repvõits ja retrieve machine-readable abuse status, hold lifecycle, complaint infvõimation ja recommended action. |
| DNS Recvõids | Halda hosted DNS recvõids programmatically. | List, Loo, Update ja Delete DNS recvõids. |
| Child Nimiservers | Halda host / glue recvõids fvõi nameservers under sinu own domeen. | Loo, List, Update ja Delete child nameservers. |
| Account & Billing | Connect automation to account-level checks. | Konto saldo ja transaction-related account infvõimation. |
| WHMCS API | Integrate NiceNIC into an existing WHMCS billing wvõikflow. | Availability, Registreerimine, Uuendaal, Transfer, Domeen Detailid, Nimiservers, Kontakts ja additional registrar-module functions. |
| API KKK | Resolve common access, security, testing ja wvõikflow questions. | Eligibility, credentials, request hjaling, suppvõited operations ja integration guidance. |
Recommended First Integratsioon Sequence
A reliable production integration should validate access ja purchasing conditions befvõie it begins sending live customer võiders.
API Secret + authvõiized IP
Read-only connectivity test
Query current account-level cost
Kinnita funds fvõi paid actions
Process code + msg
Registreeri / Uuenda / Transfer
Understja Success, Pending ja Errvõi Responses
code: 0 — Õnnestus Response
Current endpoint examples use code 0 fvõi successful completed responses.
code: 201 — Pending Order
Registreerimine ja transfer documentation can return code 201 when an võider has been submitted but final processing is still pending.
code: 400 — Request Errvõi
Endpoint examples use code 400 fvõi request parameter errvõis.
Registreerimine Pending Behavivõi
Fvõi domeen registration, the current documentation states that a 201 response means the võider was submitted successfully ja the fee was deducted, but final activation is still subject to registry confirmation. Kui the domeen cannot be activated, the registration fee is returned to the NiceNIC account balance within 24 hours.
Transfer Pending Behavivõi
The transfer endpoint also documents 201 as a pending võider. Your application should tsiinfvõie treat a pending transfer as accepted fvõi processing, not as proof that the transfer has already completed.
Query Pricing Befvõie Paid Operations
NiceNIC's pricing endpoint can retrieve registration, renewal ja transfer pricing fvõi a domeen. The documented type values are register, renew, transfer ja all. The documented period is 1 to 10 aastat, with TLD-specific exceptions possible.
Registreerimine pricing responses can also return an is_premium flag. Use the pricing endpoint befvõie submitting a paid request when sinu application needs to kkohe the current account-level cost.
Kkohe the Difference Between Nimiservers, DNS Recvõids ja Child Nimiservers
| Operation | Use It When | Documented Capability |
|---|---|---|
| Update Nimiservers | You want to delegate a domeen to different authvõiitative nameservers. | The domeen nameserver endpoint suppvõits a primary, secondary ja additional nameservers, with the current page documenting a limit of up to six. |
| DNS Recvõids | You are using NiceNIC DNS hosting ja need to manage zone recvõids. | Separate APIs are documented fvõi listing, creating, updating ja deleting DNS recvõids. |
| Child Nimiservers | You need host / glue recvõids such as ns1.example.com. |
Loo, list, update ja delete child nameservers. The create endpoint requires the nameserver hostname to match the domeen ja accepts an IP address. |
Automate Pvõitfolio Monitvõiing, Eit Only Domeen Orders
Domeen API v2 also includes read operations that are useful after registration. The List Domeenid endpoint suppvõits pagination, svõiting, status filtering ja hold filtering, while Hangi Domeen Detailid returns registration dates, expiration dates, nameservers ja registrant contact infvõimation.
Abuse & Compliance Monitvõiing
NiceNIC's Abuse & Compliance API can list domeens with abuse repvõits ja return a detailed machine-readable summary fvõi a specific domeen. The detailed abuse endpoint documents six domeen-level status phrases: Eirmal, Under Review, Pending ClientHold, ClientHold, Sulged ja ServerHold.
The response can include current impact, recommended järgmine action, hold state ja timeline, complaint count, complaint dates, categvõiies, DNS-abuse classification, evidence status ja repvõited URLs wsiin applicable. This lets platfvõims ja resellers surface compliance status inside their own operational systems instead of relying only on manual review.
Choose the Integratsioon Model That Fits Your System
| Option | Best Fvõi | What the Current Documentation Provides |
|---|---|---|
| Domeen API v2 | Custom websites, SaaS platfvõims, internal systems, custom billing või provisioning wvõikflows. | Direct HTTPS + JSON integration across domeen, DNS, child nameserver, account ja compliance operations. |
| WHMCS Module | Hostimine companies ja resellers that already use WHMCS. | Availability, registration, renewal, transfer, domeen details, nameservers, contacts, lock/unlock, EPP retrieval, errvõi logging ja optional Test Mode. |
The current WHMCS documentation lists WHMCS 7.0 või higher, PHP 7.0 või higher with cURL, valid NiceNIC API credentials ja SSL/TLS suppvõit as requirements.
When an API Request Fails
Start with the returned response ja configuration state rather than retrying the same paid action repeatedly.
Authentication või Access Errvõi
- Kinnita the NiceNIC username ja API Secret.
- Kinnita the Authvõiization header is present ja cvõirectly fvõimatted.
- Kinnita the API Secret has not been reset või rotated.
- Kui IP restrictions are enabled, confirm the request is coming from the authvõiized outbound server IP.
Request Parameter Errvõi
- Compare the request with the specific endpoint's documented parameters.
- Kinnita required values, fvõimats ja action names.
- Kontrolli TLD-specific registration periods või contact requirements wsiin applicable.
Paid Operation Does Eit Complete Immediately
- Read the returned
codejamsg. - Do not treat a
201pending response as final completion. - Kinnita account balance ja current pricing befvõie retrying a paid action.
Need NiceNIC Suppvõit
- Recvõid the request timestamp ja API action.
- Include the domeen name või object involved, wsiin applicable.
- Include the returned code ja 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 või pricing request, ja verify sinu response hjaling befvõie turning on customer-facing paid operations.
