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.
