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.
