نظرة عامة على واجهة برمجة التطبيقات
NiceNIC النطاق API v2 Documentation & Quick Start
NiceNIC النطاق API v2 is متاح للتسجيل to both حساب السوقs و الموزع الحسابs. 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 و reseller pricing are separate.
حساب السوق: API access with حساب السوق pricing.
الموزع الحساب: API access with the pricing assigned to the current reseller tier.
حساب السوق: API access with حساب السوق pricing.
الموزع الحساب: API access with the pricing assigned to the current reseller tier.
Base Endpoint
https://api.nicenic.net/v2/
Required الرأسs
Host: api.nicenic.net
Authأوization: username:api_secret
نوع المحتوى: application/json
Stوard نجاح Response
{
"code": 0,
"الرسالة": "success",
"data": {}
}
API Sوbox
Test Your التكامل Befأوe Going Live
Use the واجهة NiceNIC البرمجية 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.
Quick Start
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.
1
Enable API Access
فتح إعدادات APIs, create أو retrieve الخاص بك API Secret, و configure authأوized server IPs wهنا applicable.
2
تأكيد المصادقة
Use HTTPS with the Authأوization header in the fأوmat username:api_secret.
3
Run a Safe Test
Start with النطاق availability, pricing, account balance أو النطاق listing.
4
Hوle the Response
Read و stأوe the returned code و msg befأوe enabling paid production الإجراءs.
Recommended First Request: النطاق Availability
The availability endpoint suppأوts multiple النطاقs in one request by separating النطاق names with commas.
curl "https://api.nicenic.net/v2/?الفئة=النطاق&الإجراء=check&النطاقs=example.com,example.net" \
-H "Authأوization: username:api_secret" \
-H "نوع المحتوى: application/json"
API Map
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 |
|---|---|---|
| البدء | Connect securely و understو response hوling. | نظرة عامة على واجهة برمجة التطبيقات, API Sوbox, المصادقة, Response Codes. |
| إدارة النطاقات | Automate the cأوe النطاق lifecycle. | Availability, List النطاقات, النطاق التفاصيل, التسجيل, تجديدal, نقل In, الاسمservers, اتصالs, Pricing. |
| الإساءة والامتثال | Monitأو النطاقs that require compliance attention. | List النطاقs with abuse repأوts و retrieve machine-readable abuse status, hold lifecycle, complaint infأوmation و recommended الإجراء. |
| سجلات نظام أسماء النطاقات | إدارة hosted DNS recأوds programmatically. | List, إنشاء, Update و Delete DNS recأوds. |
| خوادم أسماء الأطفال | إدارة host / glue recأوds fأو nameservers under الخاص بك own النطاق. | إنشاء, List, Update و Delete child nameservers. |
| الحساب والفوترة | Connect automation to account-level checks. | رصيد الحساب و transالإجراء-related account infأوmation. |
| واجهة برمجة تطبيقات WHMCS | Integrate NiceNIC into an existing WHMCS billing wأوkflow. | Availability, التسجيل, تجديدal, نقل, النطاق التفاصيل, الاسم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 Wأوkflow
Recommended First التكامل Sequence
A reliable production integration should validate access و purchasing conditions befأوe it begins sending live customer أوders.
1. المصادقة
API Secret + authأوized IP
API Secret + authأوized IP
→
2. Availability
Read-only connectivity test
Read-only connectivity test
→
3. Pricing
Query current account-level cost
Query current account-level cost
→
4. الرصيد
تأكيد funds fأو paid الإجراءs
تأكيد funds fأو paid الإجراءs
→
5. Response Hوling
Process code + الرسالة
Process code + الرسالة
→
6. Live Operations
تسجيل / تجديد / نقل
تسجيل / تجديد / نقل
Do not assume that an API request is complete simply because it was accepted. Some operations can return a pending status و still require registry processing befأوe the final النطاق state is confirmed.
المنتجion Behaviأو
Understو نجاح, قيد الانتظار و Errأو Responses
code: 0 — ناجح Response
Current endpoint examples use code 0 fأو successful completed responses.
code: 201 — قيد الانتظار 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 خطأs.
التسجيل قيد الانتظار 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.
نقل قيد الانتظار 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.
Pricing
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.
مجاني API access does not change الخاص بك pricing tier. حساب السوقs use حساب السوق pricing; reseller accounts use the pricing assigned to their current reseller tier.
النطاق & DNS Operations
Kالآن the Difference Between الاسمservers, سجلات نظام أسماء النطاقات و خوادم أسماء الأطفال
| Operation | Use It When | Documented Capability |
|---|---|---|
| تحديث خوادم الأسماء | 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. |
| سجلات نظام أسماء النطاقات | You are using NiceNIC DNS hosting و need to manage zone recأوds. | Separate APIs are documented fأو listing, creating, updating و deleting DNS recأوds. |
| خوادم أسماء الأطفال | 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. |
Pأوtfolio & Compliance
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.
الإساءة والامتثال Monitأوing
NiceNIC's الإساءة والامتثال 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, قيد الانتظار ClientHold, ClientHold, إغلاقd و الخادمHold.
The response can include current impact, recommended التالي الإجراء, 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.
Direct API أو WHMCS
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, خطأ logging و optional Test Mode. |
The current WHMCS documentation lists WHMCS 7.0 أو أعلى, PHP 7.0 أو higher with cURL, valid واجهة NiceNIC البرمجية credentials و شهادة SSL/TLS suppأوt as requirements.
Troubleshooting
When an API Request Fails
Start with the returned response و configuration state rather than retrying the same paid الإجراء repeatedly.
المصادقة أو 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 و الإجراء 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 الإجراء.
Need NiceNIC Suppأوt
- Recأوd the request timestamp و API الإجراء.
- 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.
Last verified: August 26, 2026
