Dokumentation och snabbstart för NiceNIC:s domän-API v2
NiceNIC:s domän-API v2 är tillgängligt för både marknadskonton och återförsäljarkonton. Använd den här översikten för att konfigurera åtkomst, verifiera din första förfrågan, förstå API:ets svarsmodell och gå direkt till rätt avsnitt i den vänstra navigeringen.
Marknadskonto: API-åtkomst med prissättning för marknadskonton.
Återförsäljarkonto: API-åtkomst med den prissättning som tilldelats den aktuella återförsäljarnivån.
Jämför återförsäljarnivåer och priser →
Testa din integration innan du går live
Använd NiceNIC:s API-sandlåda för att testa din domän-API-integration innan du går till produktion. Validera autentisering, API-anrop, svarshantering och ditt applikationsarbetsflöde i en dedikerad testmiljö.
Idealiskt för återförsäljare, webbhotell, utvecklare och plattformar som förbereder en API-integration.
Gör ditt första API-anrop i 4 steg
Börja med en skrivskyddad förfrågan innan du aktiverar live-registreringar, förnyelser eller överföringar. På så sätt kan du verifiera autentisering, förfrågningsformatering och svarshantering utan att lägga en betald order.
Aktivera API-åtkomst
Öppna API-inställningarna, skapa eller hämta din API-hemlighet och konfigurera auktoriserade server-IP:er där det är tillämpligt.
Bekräfta autentisering
Använd HTTPS med Authorization-huvudet i formatet username:api_secret.
Kör ett säkert test
Börja med domäntillgänglighet, priser, kontosaldo eller domänlistning.
Hantera svaret
Läs och lagra returnerade code och msg innan du aktiverar betalda produktionsåtgärder.
Rekommenderat första anrop: Domäntillgänglighet
Tillgänglighetsslutpunkten stöder flera domäner i ett anrop genom att domännamnen separeras med kommatecken.
Välj det arbetsflöde du behöver
Översikten nedan speglar vänsternavigeringen. Använd den för att identifiera rätt arbetsflöde och öppna sedan den dedikerade slutpunktssidan för parametrar, exempel på anrop och exempel på svar.
| Avsnitt | Används för | Dokumenterade funktioner |
|---|---|---|
| Komma igång | Anslut säkert och förstå hur svar hanteras. | API-översikt, API-sandlåda, autentisering, svarskoder. |
| Domänhantering | Automatisera den grundläggande domänlivscykeln. | tillgänglighet, lista domäner, domändetaljer, registrering, förnyelse, inkommande överföring, namnservrar, kontakter, prissättning. |
| Missbruk & regelefterlevnad | Övervaka domäner som kräver uppmärksamhet avseende regelefterlevnad. | Lista domäner med missbruksrapporter och hämta maskinläsbar missbruksstatus, spärrlivscykel, klagomålsinformation och rekommenderad åtgärd. |
| DNS-poster | Hantera värdbaserade DNS-poster programmatiskt. | Lista, skapa, uppdatera och ta bort DNS-poster. |
| Underordnade namnservrar | Hantera värd-/glue-poster för namnservrar under din egen domän. | Skapa, lista, uppdatera och ta bort underordnade namnservrar. |
| Konto och fakturering | Anslut automatisering till kontroller på kontonivå. | Kontosaldo och transaktionsrelaterad kontoinformation. |
| WHMCS API | Integrera NiceNIC i ett befintligt WHMCS-faktureringsflöde. | Tillgänglighet, registrering, förnyelse, överföring, domändetaljer, namnservrar, kontakter och ytterligare funktioner i registrar-modulen. |
| API: vanliga frågor | Red ut vanliga frågor om åtkomst, säkerhet, testning och arbetsflöden. | Behörighet, autentiseringsuppgifter, hantering av förfrågningar, åtgärder som stöds och integrationsvägledning. |
Rekommenderad första integrationssekvens
En tillförlitlig produktionsintegration bör validera åtkomst- och köpvillkor innan den börjar skicka live kundorder.
API-hemlighet + auktoriserad IP
Skrivskyddad anslutningstest
Fråga efter aktuell kostnad på kontonivå
Bekräfta medel för betalda åtgärder
Bearbeta kod + meddelande
Registrera / Förnya / Överföra
Förstå lyckade, väntande och felaktiga svar
code: 0 — Lyckat svar De aktuella slutpunktsexemplen använder kod 0 för lyckade slutförda svar.
code: 201 — Väntande order Dokumentationen för registrering och överföring kan returnera kod 201 när en order har skickats in men den slutliga behandlingen ännu inte har slutförts.
code: 400 — Begäranfel Slutpunktsexemplen använder kod 400 för parametrarfel i begäran.
Beteende vid väntande registrering
För domänregistrering anger den aktuella dokumentationen att ett 201-svar innebär att beställningen har skickats in och avgiften har dragits, men att slutlig aktivering fortfarande är beroende av registrets bekräftelse. Om domänen inte kan aktiveras återförs registreringsavgiften till saldot på NiceNIC-kontot inom 24 timmar.
Beteende vid väntande överföring
Överföringsendpointen dokumenterar även 201 som en väntande order. Din applikation bör därför behandla en väntande överföring som accepterad för bearbetning, inte som bevis på att överföringen redan har slutförts.
Hämta priser innan betalda operationer
NiceNIC:s prisändpunkt kan hämta priser för registrering, förnyelse och överföring av en domän. De dokumenterade type-värdena är register, renew, transfer och all. Den dokumenterade perioden är 1 till 10 år; TLD-specifika undantag kan förekomma.
Svar med registreringspriser kan också returnera en is_premium-flagga. Använd prisändpunkten innan du skickar en betald begäran när din applikation behöver känna till den aktuella kostnaden på kontonivå.
Vet skillnaden mellan namnservrar, DNS-poster och underordnade namnservrar
| Funktion | Använd det när | Dokumenterad kapacitet |
|---|---|---|
| Uppdatera namnservrar | Du vill delegera en domän till olika auktoritativa namnservrar. | Slutpunkten för domänens namnservrar har stöd för en primär, en sekundär och ytterligare namnservrar. Den aktuella sidan dokumenterar en gräns på upp till sex. |
| DNS-poster | Du använder NiceNIC DNS-hosting och behöver hantera zonposter. | Separata API:er dokumenteras för att lista, skapa, uppdatera och ta bort DNS-poster. |
| Underordnade namnservrar | Du behöver värd-/glue-poster, till exempel ns1.example.com. |
Skapa, lista, uppdatera och ta bort underordnade namnservrar. Slutpunkten för att skapa kräver att namnserverns värdnamn matchar domänen och accepterar en IP-adress. |
Automatisera portföljövervakning, inte bara domänbeställningar
Domän-API v2 innehåller även läsoperationer som är användbara efter registrering. Slutpunkten List Domains stöder paginering, sortering, statusfiltrering och spärrfiltrering, medan Get Domain Details returnerar registreringsdatum, utgångsdatum, namnservrar och registrantens kontaktuppgifter.
Övervakning av missbruk och regelefterlevnad
NiceNIC:s API för missbruk och regelefterlevnad kan lista domäner med missbruksrapporter och returnera en detaljerad maskinläsbar sammanfattning för en specifik domän. Slutpunkten för detaljerad missbruksinformation dokumenterar sex domännivåstatusar: Normal, Under granskning, Väntande ClientHold, ClientHold, Stängd och ServerHold.
Svaret kan innehålla aktuell påverkan, rekommenderad nästa åtgärd, spärrstatus och tidslinje, antal klagomål, klagomålsdatum, kategorier, DNS-missbruksklassificering, bevisstatus och rapporterade URL:er där tillämpligt. Detta gör det möjligt för plattformar och återförsäljare att visa regelefterlevnadsstatus i sina egna operativa system i stället för att endast förlita sig på manuell granskning.
Välj den integrationsmodell som passar ditt system
| Alternativ | Bäst för | Vad den aktuella dokumentationen tillhandahåller |
|---|---|---|
| Domän-API v2 | Skräddarsydda webbplatser, SaaS-plattformar, interna system, anpassade arbetsflöden för fakturering eller provisionering. | Direkt integration via HTTPS + JSON för operationer som rör domäner, DNS, underordnade namnservrar, konton och regelefterlevnad. |
| WHMCS-modul | Hostingföretag och återförsäljare som redan använder WHMCS. | Tillgänglighet, registrering, förnyelse, överföring, domänuppgifter, namnservrar, kontakter, låsning/upplåsning, EPP-hämtning, felloggning och valfritt testläge. |
Den aktuella WHMCS-dokumentationen listar WHMCS 7.0 eller senare, PHP 7.0 eller senare med cURL, giltiga NiceNIC API-uppgifter och SSL/TLS-stöd som krav.
När en API-förfrågan misslyckas
Börja med det returnerade svaret och konfigurationsstatusen i stället för att upprepa samma betalda åtgärd flera gånger.
Autentiserings- eller åtkomstfel
- Kontrollera att NiceNIC-användarnamnet och API-hemligheten är korrekta.
- Kontrollera att Authorization-headern finns och har korrekt format.
- Kontrollera att API-hemligheten inte har återställts eller roterats.
- Om IP-begränsningar är aktiverade, kontrollera att begäran kommer från den auktoriserade utgående server-IP-adressen.
Parameterfel i begäran
- Jämför begäran med den specifika slutpunktens dokumenterade parametrar.
- Verifiera obligatoriska värden, format och åtgärdsnamn.
- Kontrollera TLD-specifika registreringsperioder eller kontaktkrav i förekommande fall.
En betald åtgärd slutförs inte omedelbart
- Läs de returnerade fälten
codeochmsg. - Betrakta inte ett väntande
201-svar som att åtgärden är slutgiltigt slutförd. - Kontrollera kontosaldo och aktuell prissättning innan du försöker utföra en betald åtgärd igen.
Behöver du support från NiceNIC?
- Anteckna tidstämpeln för begäran och API-åtgärden.
- Inkludera domännamnet eller det berörda objektet, i förekommande fall.
- Inkludera den returnerade koden och meddelandet.
- Dela endast icke-känsliga parametrar; skicka aldrig hela API-hemligheten i ett ärende.
Börja med en säker testförfrågan
Aktivera API-åtkomst, bekräfta autentiseringen, skicka en tillgänglighets- eller prisförfrågan och verifiera att du hanterar svaren korrekt innan du aktiverar kundinriktade betalda operationer.






