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.
