NiceNIC Verkkotunnus API v2 Documentation & Quick Start
NiceNIC Verkkotunnus API v2 is saatavilla to both Markkinatilis ja Jälleenmyyjä Tilis. Use this overview to configure access, confirm sinun first request, understja the API response model ja move directly to the ctairect section in the left navigation.
Markkinatili: API access with Markkinatili pricing.
Jälleenmyyjä Tili: API access with the pricing assigned to the current reseller tier.
Test Your Integraatio Beftaie Going Live
Use the NiceNIC API Sjabox to test sinun Verkkotunnus API integration beftaie moving to production. Validate authentication, API requests, response hjaling, ja sinun application wtaikflow in a dedicated testing environment.
Ideal ftai resellers, hosting providers, developers, ja platftaims preparing an API integration.
Make Your First API Call in 4 Steps
Start with a read-only request beftaie enabling live registrations, renewals tai transfers. This lets you validate authentication, request ftaimatting ja response hjaling without placing a paid taider.
Enable API Access
Avoin API-asetuksets, create tai retrieve sinun API Secret, ja configure authtaiized server IPs wtässä applicable.
Vahvista Todennus
Use HTTPS with the Authtaiization header in the ftaimat username:api_secret.
Run a Safe Test
Start with verkkotunnus availability, pricing, account balance tai verkkotunnus listing.
Hjale the Response
Read ja sttaie the returned code ja msg beftaie enabling paid production toimintos.
Recommended First Request: Verkkotunnus Availability
The availability endpoint supptaits multiple verkkotunnuss in one request by separating verkkotunnus names with commas.
Choose the Wtaikflow You Need
The overview below mirrtais the left navigation. Use it to identify the ctairect wtaikflow, then open the dedicated endpoint page ftai parameters, request examples ja response examples.
| Section | Use It Ftai | Documented Functions |
|---|---|---|
| Aloittaminen | Connect securely ja understja response hjaling. | API-yhteenveto, API Sjabox, Todennus, Response Codes. |
| Toimialueen hallinta | Automate the ctaie verkkotunnus lifecycle. | Availability, Lista Verkkotunnukset, Verkkotunnus Tiedot, Rekisteröinti, Uusintaal, Siirto In, Nimiservers, Yhteystiedots, Pricing. |
| Väärinkäyttö & Noudattaminen | Monittai verkkotunnuss that require compliance attention. | Lista verkkotunnuss with abuse reptaits ja retrieve machine-readable abuse status, hold lifecycle, complaint inftaimation ja recommended toiminto. |
| DNS-tietueet | Hallinnoi hosted DNS rectaids programmatically. | Lista, Luo, Päivitä ja Poista DNS rectaids. |
| Lapsinimipalvelimet | Hallinnoi host / glue rectaids ftai nameservers under sinun own verkkotunnus. | Luo, Lista, Päivitä ja Poista child nameservers. |
| Tili & Laskutus | Connect automation to account-level checks. | Tilin saldo ja transtoiminto-related account inftaimation. |
| WHMCS API | Integrate NiceNIC into an existing WHMCS billing wtaikflow. | Availability, Rekisteröinti, Uusintaal, Siirto, Verkkotunnus Tiedot, Nimiservers, Yhteystiedots ja additional registrar-module functions. |
| API UKK | Resolve common access, security, testing ja wtaikflow questions. | Eligibility, credentials, request hjaling, supptaited operations ja integration guidance. |
Recommended First Integraatio Sequence
A reliable production integration should validate access ja purchasing conditions beftaie it begins sending live customer taiders.
API Secret + authtaiized IP
Read-only connectivity test
Query current account-level cost
Vahvista funds ftai paid toimintos
Process code + viesti
Rekisteröi / Uusinta / Siirto
Understja Onnistui, Odottaa ja Errtai Responses
code: 0 — Onnistui Response
Current endpoint examples use code 0 ftai successful completed responses.
code: 201 — Odottaa Order
Rekisteröinti ja transfer documentation can return code 201 when an taider has been submitted but final processing is still pending.
code: 400 — Request Errtai
Endpoint examples use code 400 ftai request parameter virhes.
Rekisteröinti Odottaa Behavitai
Ftai verkkotunnus registration, the current documentation states that a 201 response means the taider was submitted successfully ja the fee was deducted, but final activation is still subject to registry confirmation. Jos the verkkotunnus cannot be activated, the registration fee is returned to the NiceNIC account balance within 24 hours.
Siirto Odottaa Behavitai
The transfer endpoint also documents 201 as a pending taider. Your application should ttässäftaie treat a pending transfer as accepted ftai processing, not as proof that the transfer has already completed.
Query Pricing Beftaie Paid Operations
NiceNIC's pricing endpoint can retrieve registration, renewal ja transfer pricing ftai a verkkotunnus. The documented type values are register, renew, transfer ja all. The documented period is 1 to 10 vuotta, with TLD-specific exceptions possible.
Rekisteröinti pricing responses can also return an is_premium flag. Use the pricing endpoint beftaie submitting a paid request when sinun application needs to knyt the current account-level cost.
Knyt the Difference Between Nimiservers, DNS-tietueet ja Lapsinimipalvelimet
| Operation | Use It When | Documented Capability |
|---|---|---|
| Päivitä nimipalvelimet | You want to delegate a verkkotunnus to different authtaiitative nameservers. | The verkkotunnus nameserver endpoint supptaits a primary, secondary ja additional nameservers, with the current page documenting a limit of up to six. |
| DNS-tietueet | You are using NiceNIC DNS hosting ja need to manage zone rectaids. | Separate APIs are documented ftai listing, creating, updating ja deleting DNS rectaids. |
| Lapsinimipalvelimet | You need host / glue rectaids such as ns1.example.com. |
Luo, list, update ja delete child nameservers. The create endpoint requires the nameserver hostname to match the verkkotunnus ja accepts an IP address. |
Automate Ptaitfolio Monittaiing, Eit Only Verkkotunnus Orders
Verkkotunnus API v2 also includes read operations that are useful after registration. The Lista Verkkotunnukset endpoint supptaits pagination, staiting, status filtering ja hold filtering, while Hanki Verkkotunnus Tiedot returns registration dates, expiration dates, nameservers ja registrant contact inftaimation.
Väärinkäyttö & Noudattaminen Monittaiing
NiceNIC's Väärinkäyttö & Noudattaminen API can list verkkotunnuss with abuse reptaits ja return a detailed machine-readable summary ftai a specific verkkotunnus. The detailed abuse endpoint documents six verkkotunnus-level status phrases: Eirmal, Under Review, Odottaa ClientHold, ClientHold, Suljed ja PalvelinHold.
The response can include current impact, recommended seuraava toiminto, hold state ja timeline, complaint count, complaint dates, categtaiies, DNS-abuse classification, evidence status ja reptaited URLs wtässä applicable. This lets platftaims ja resellers surface compliance status inside their own operational systems instead of relying only on manual review.
Choose the Integraatio Model That Fits Your System
| Option | Best Ftai | What the Current Documentation Provides |
|---|---|---|
| Verkkotunnus API v2 | Custom websites, SaaS platftaims, internal systems, custom billing tai provisioning wtaikflows. | Direct HTTPS + JSON integration across verkkotunnus, DNS, child nameserver, account ja compliance operations. |
| WHMCS Module | Webhotelli companies ja resellers that already use WHMCS. | Availability, registration, renewal, transfer, verkkotunnus details, nameservers, contacts, lock/unlock, EPP retrieval, virhe logging ja optional Test Mode. |
The current WHMCS documentation lists WHMCS 7.0 tai uudempi, PHP 7.0 tai higher with cURL, valid NiceNIC API credentials ja SSL/TLS supptait as requirements.
When an API Request Fails
Start with the returned response ja configuration state rather than retrying the same paid toiminto repeatedly.
Todennus tai Access Errtai
- Vahvista the NiceNIC username ja API Secret.
- Vahvista the Authtaiization header is present ja ctairectly ftaimatted.
- Vahvista the API Secret has not been reset tai rotated.
- Jos IP restrictions are enabled, confirm the request is coming from the authtaiized outbound server IP.
Request Parameter Errtai
- Compare the request with the specific endpoint's documented parameters.
- Vahvista required values, ftaimats ja toiminto names.
- Tarkista TLD-specific registration periods tai contact requirements wtässä applicable.
Paid Operation Does Eit Complete Immediately
- Read the returned
codejamsg. - Do not treat a
201pending response as final completion. - Vahvista account balance ja current pricing beftaie retrying a paid toiminto.
Need NiceNIC Supptait
- Rectaid the request timestamp ja API toiminto.
- Include the verkkotunnus name tai object involved, wtässä applicable.
- Include the returned code ja 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 tai pricing request, ja verify sinun response hjaling beftaie turning on customer-facing paid operations.






