NiceNIC Tên miền API v2 Documentation & Quick Start
NiceNIC Tên miền API v2 is available to both Tài khoản thị trườngs và Đại lý Accounts. Use this overview to configure access, confirm của bạn first request, understvà the API response model và move directly to the choặcrect section in the left navigation.
Tài khoản thị trường: API access with Tài khoản thị trường pricing.
Đại lý Account: API access with the pricing assigned to the current reseller tier.
Test Your Tích hợp Befhoặce Going Live
Use the NiceNIC API Svàbox to test của bạn Tên miền API integration befhoặce moving to production. Validate authentication, API requests, response hvàling, và của bạn application whoặckflow in a dedicated testing environment.
Ideal fhoặc resellers, hosting providers, developers, và platfhoặcms preparing an API integration.
Make Your First API Call in 4 Steps
Start with a read-only request befhoặce enabling live registrations, renewals hoặc transfers. This lets you validate authentication, request fhoặcmatting và response hvàling without placing a paid hoặcder.
Enable API Access
Mở Cài đặt APIs, create hoặc retrieve của bạn API Secret, và configure authhoặcized server IPs wtại đây applicable.
Xác nhận Authentication
Use HTTPS with the Authhoặcization header in the fhoặcmat username:api_secret.
Run a Safe Test
Start with tên miền availability, pricing, account balance hoặc tên miền listing.
Hvàle the Response
Read và sthoặce the returned code và msg befhoặce enabling paid production actions.
Recommended First Request: Tên miền Availability
The availability endpoint supphoặcts multiple tên miềns in one request by separating tên miền names with commas.
Choose the Whoặckflow You Need
The overview below mirrhoặcs the left navigation. Use it to identify the choặcrect whoặckflow, then open the dedicated endpoint page fhoặc parameters, request examples và response examples.
| Section | Use It Fhoặc | Documented Functions |
|---|---|---|
| Nhậnting Started | Connect securely và understvà response hvàling. | API Overview, API Svàbox, Authentication, Response Codes. |
| Tên miền Quản lýment | Automate the choặce tên miền lifecycle. | Availability, List Tên miền, Tên miền Chi tiết, Đăng ký, Gia hạnal, Transfer In, Tênservers, Liên hệs, Pricing. |
| Abuse & Compliance | Monithoặc tên miềns that require compliance attention. | List tên miềns with abuse rephoặcts và retrieve machine-readable abuse status, hold lifecycle, complaint infhoặcmation và recommended action. |
| DNS Rechoặcds | Quản lý hosted DNS rechoặcds programmatically. | List, Tạo, Update và Delete DNS rechoặcds. |
| Child Tênservers | Quản lý host / glue rechoặcds fhoặc nameservers under của bạn own tên miền. | Tạo, List, Update và Delete child nameservers. |
| Account & Billing | Connect automation to account-level checks. | Số dư tài khoản và transaction-related account infhoặcmation. |
| WHMCS API | Integrate NiceNIC into an existing WHMCS billing whoặckflow. | Availability, Đăng ký, Gia hạnal, Transfer, Tên miền Chi tiết, Tênservers, Liên hệs và additional registrar-module functions. |
| API Câu hỏi thường gặp | Resolve common access, security, testing và whoặckflow questions. | Eligibility, credentials, request hvàling, supphoặcted operations và integration guidance. |
Recommended First Tích hợp Sequence
A reliable production integration should validate access và purchasing conditions befhoặce it begins sending live customer hoặcders.
API Secret + authhoặcized IP
Read-only connectivity test
Query current account-level cost
Xác nhận funds fhoặc paid actions
Process code + msg
Đăng ký / Gia hạn / Transfer
Understvà Success, Pending và Errhoặc Responses
code: 0 — Thành công Response
Current endpoint examples use code 0 fhoặc successful completed responses.
code: 201 — Pending Order
Đăng ký và transfer documentation can return code 201 when an hoặcder has been submitted but final processing is still pending.
code: 400 — Request Errhoặc
Endpoint examples use code 400 fhoặc request parameter errhoặcs.
Đăng ký Pending Behavihoặc
Fhoặc tên miền registration, the current documentation states that a 201 response means the hoặcder was submitted successfully và the fee was deducted, but final activation is still subject to registry confirmation. Nếu the tên miền cannot be activated, the registration fee is returned to the NiceNIC account balance within 24 hours.
Transfer Pending Behavihoặc
The transfer endpoint also documents 201 as a pending hoặcder. Your application should ttại đâyfhoặce treat a pending transfer as accepted fhoặc processing, not as proof that the transfer has already completed.
Query Pricing Befhoặce Paid Operations
NiceNIC's pricing endpoint can retrieve registration, renewal và transfer pricing fhoặc a tên miền. The documented type values are register, renew, transfer và all. The documented period is 1 to 10 năm, with TLD-specific exceptions possible.
Đăng ký pricing responses can also return an is_premium flag. Use the pricing endpoint befhoặce submitting a paid request when của bạn application needs to kngay the current account-level cost.
Kngay the Difference Between Tênservers, DNS Rechoặcds và Child Tênservers
| Operation | Use It When | Documented Capability |
|---|---|---|
| Update Tênservers | You want to delegate a tên miền to different authhoặcitative nameservers. | The tên miền nameserver endpoint supphoặcts a primary, secondary và additional nameservers, with the current page documenting a limit of up to six. |
| DNS Rechoặcds | You are using NiceNIC DNS hosting và need to manage zone rechoặcds. | Separate APIs are documented fhoặc listing, creating, updating và deleting DNS rechoặcds. |
| Child Tênservers | You need host / glue rechoặcds such as ns1.example.com. |
Tạo, list, update và delete child nameservers. The create endpoint requires the nameserver hostname to match the tên miền và accepts an IP address. |
Automate Phoặctfolio Monithoặcing, Khôngt Only Tên miền Orders
Tên miền API v2 also includes read operations that are useful after registration. The List Tên miền endpoint supphoặcts pagination, shoặcting, status filtering và hold filtering, while Nhận Tên miền Chi tiết returns registration dates, expiration dates, nameservers và registrant contact infhoặcmation.
Abuse & Compliance Monithoặcing
NiceNIC's Abuse & Compliance API can list tên miềns with abuse rephoặcts và return a detailed machine-readable summary fhoặc a specific tên miền. The detailed abuse endpoint documents six tên miền-level status phrases: Khôngrmal, Under Review, Pending ClientHold, ClientHold, Đóngd và ServerHold.
The response can include current impact, recommended tiếp theo action, hold state và timeline, complaint count, complaint dates, categhoặcies, DNS-abuse classification, evidence status và rephoặcted URLs wtại đây applicable. This lets platfhoặcms và resellers surface compliance status inside their own operational systems instead of relying only on manual review.
Choose the Tích hợp Model That Fits Your System
| Option | Best Fhoặc | What the Current Documentation Provides |
|---|---|---|
| Tên miền API v2 | Custom websites, SaaS platfhoặcms, internal systems, custom billing hoặc provisioning whoặckflows. | Direct HTTPS + JSON integration across tên miền, DNS, child nameserver, account và compliance operations. |
| WHMCS Module | Hosting companies và resellers that already use WHMCS. | Availability, registration, renewal, transfer, tên miền details, nameservers, contacts, lock/unlock, EPP retrieval, errhoặc logging và optional Test Mode. |
The current WHMCS documentation lists WHMCS 7.0 hoặc higher, PHP 7.0 hoặc higher with cURL, valid NiceNIC API credentials và SSL/TLS supphoặct as requirements.
When an API Request Fails
Start with the returned response và configuration state rather than retrying the same paid action repeatedly.
Authentication hoặc Access Errhoặc
- Xác nhận the NiceNIC username và API Secret.
- Xác nhận the Authhoặcization header is present và choặcrectly fhoặcmatted.
- Xác nhận the API Secret has not been reset hoặc rotated.
- Nếu IP restrictions are enabled, confirm the request is coming from the authhoặcized outbound server IP.
Request Parameter Errhoặc
- Compare the request with the specific endpoint's documented parameters.
- Xác nhận required values, fhoặcmats và action names.
- Kiểm tra TLD-specific registration periods hoặc contact requirements wtại đây applicable.
Paid Operation Does Khôngt Complete Immediately
- Read the returned
codevàmsg. - Do not treat a
201pending response as final completion. - Xác nhận account balance và current pricing befhoặce retrying a paid action.
Need NiceNIC Supphoặct
- Rechoặcd the request timestamp và API action.
- Include the tên miền name hoặc object involved, wtại đây applicable.
- Include the returned code và 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 hoặc pricing request, và verify của bạn response hvàling befhoặce turning on customer-facing paid operations.
