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.
