NiceNIC Domain API v2 Dokumentace a Rychlý start
NiceNIC Domain API v2 je k dispozici pro obchodní účty i účty prodejců. V tomto přehledu nakonfigurujete přístup, ověříte svůj první požadavek, porozumíte modelu odpovědí API a přímo přejdete na správnou sekci v levé navigaci.
Obchodní účet: Přístup k API s cenami pro obchodní účet.
Účet prodejce: Přístup k API s cenami přiřazenými k aktuální úrovni prodejce.
Porovnat úrovně prodejců a ceny →
Otestujte svou integraci před spuštěním do provozu
Použijte NiceNIC API Sandbox k otestování integrace svého Domain API před přechodem do produkčního prostředí. Ověřte si autentizaci, API požadavky, zpracování odpovědí a pracovní postup své aplikace ve vyhrazeném testovacím prostředí.
Ideální pro resellery, poskytovatele hostingu, vývojáře a platformy připravující integraci API.
Proveďte své první volání API ve 4 krocích
Začněte s požadavkem pouze pro čtení před povolením živých registrací, obnovení nebo převodů. To vám umožní ověřit autentizaci, formátování požadavků a zpracování odpovědí bez provedení placené objednávky.
Povolit přístup k API
Otevřete Nastavení API, vytvořte nebo získejte svůj API tajný klíč a případně nakonfigurujte autorizované IP adresy serverů.
Potvrdit ověření
Použijte HTTPS s hlavičkou Authorization ve formátu username:api_secret.
Proveďte bezpečný test
Začněte s dostupností domény, cenami, zůstatkem na účtu nebo seznamem domén.
Zpracování odpovědi
Přečtěte si a uložte vrácené code a msg před povolením placených produkčních akcí.
Doporučený první požadavek: Dostupnost domény
Koncový bod dostupnosti podporuje více domén v jednom požadavku oddělených čárkami.
Zvolte si pracovní postup, který potřebujete
Přehled níže odpovídá levému navigačnímu panelu. Pomocí něj identifikujte správný pracovní postup a poté otevřete příslušnou stránku koncového bodu pro parametry, příklady požadavků a příklady odpovědí.
| Sekce | K čemu se používá | Dokumentované funkce |
|---|---|---|
| Začínáme | Připojte se bezpečně a pochopte zpracování odpovědí. | Přehled API, Testovací prostředí API, Autentizace, Kódy odpovědí. |
| Správa domén | Automatizujte základní životní cyklus domén. | Dostupnost, Seznam domén, Detaily domény, Registrace, Obnovení, Převod domény, Jmenné servery, Kontakty, Ceník. |
| Zneužití & shoda | Sledujte domény vyžadující pozornost v oblasti souladu s předpisy. | Zobrazte domény s hlášeními o zneužití a získejte strojově čitelný stav zneužití, životní cyklus pozastavení, informace o stížnostech a doporučené opatření. |
| DNS záznamy | Spravujte hostované DNS záznamy programově. | Zobrazit, vytvořit, aktualizovat a smazat DNS záznamy. |
| Podřízené nameservery | Spravovat hostitelské / glue záznamy pro jmenné servery v rámci vaší vlastní domény. | Vytvářet, zobrazovat, aktualizovat a mazat dětské jmenné servery. |
| Účet & fakturace | Propojit automatizaci s kontrolami na úrovni účtu. | Zůstatek účtu a transakční informace související s účtem. |
| WHMCS API | Integrace NiceNIC do stávajícího fakturačního workflow WHMCS. | Dostupnost, registrace, obnovení, převod, podrobnosti o doméně, jmenné servery, kontakty a další funkce registrátorského modulu. |
| Časté dotazy k API | Řešení běžných otázek týkajících se přístupu, zabezpečení, testování a pracovních postupů. | Způsobilost, přihlašovací údaje, zpracování požadavků, podporované operace a pokyny k integraci. |
Doporučené pořadí prvotní integrace
Spolehlivá produkční integrace by měla ověřit přístupové a nákupní podmínky ještě před odesíláním živých zákaznických objednávek.
Tajemství API + autorizovaná IP adresa
Test připojení pouze pro čtení
Dotaz na aktuální náklady na úrovni účtu
Ověření finančních prostředků pro placené akce
Zpracování kódu + zprávy
Registrace / Obnovení / Převod
Porozumění odpovědím Success, Pending a Error
code: 0 — Úspěšná odpověď Aktuální příklady koncových bodů používají kód 0 pro úspěšně dokončené odpovědi.
code: 201 — Čekající objednávka Dokumentace k registraci a převodu může vrátit kód 201, pokud byla objednávka odeslána, ale konečné zpracování stále probíhá.
code: 400 — Chyba požadavku Příklady koncových bodů používají kód 400 pro chyby parametrů požadavku.
Chování při čekající registraci
Pro registraci domény aktuální dokumentace uvádí, že odpověď 201 znamená, že objednávka byla úspěšně odeslána a poplatek byl odečten, ale konečná aktivace je stále předmětem potvrzení registru. Pokud doménu nelze aktivovat, registrační poplatek bude vrácen na zůstatek účtu NiceNIC do 24 hodin.
Chování čekajících převodů
Endpoint pro převody také dokumentuje 201 jako čekající objednávku. Vaše aplikace by proto měla čekající převod považovat za přijatý ke zpracování, nikoli za důkaz, že převod již byl dokončen.
Zjištění ceny před placenými operacemi
Cenový endpoint služby NiceNIC může získat ceny registrace, prodloužení a převodu domény. Dokumentované hodnoty type jsou register, renew, transfer a all. Dokumentované období je 1 až 10 let, s možnými výjimkami podle TLD.
Odpovědi s cenou registrace mohou také vrátit příznak is_premium. Před odesláním placeného požadavku použijte cenový endpoint, pokud vaše aplikace potřebuje znát aktuální cenu pro daný účet.
Rozdíl mezi nameservery, DNS záznamy a dětskými nameservery
| Operace | Kdy použít | Dokumentovaná funkce |
|---|---|---|
| Aktualizovat názvové servery | Chcete delegovat doménu na různé autoritativní nameservery. | Koncový bod nameserveru domény podporuje primární, sekundární a další nameservery; aktuální stránka uvádí limit až šesti. |
| DNS záznamy | Používáte DNS hosting NiceNIC a potřebujete spravovat záznamy zón. | Pro výpis, vytváření, aktualizaci a mazání DNS záznamů jsou dokumentovány samostatné API. |
| Podřízené nameservery | Potřebujete hostitelské / glue záznamy, jako je ns1.example.com. |
Vytvářejte, vypisujte, aktualizujte a mažte dětské nameservery. Koncový bod pro vytváření vyžaduje, aby hostname nameserveru odpovídal doméně, a přijímá IP adresu. |
Automatizujte monitorování portfolia, nejen objednávky domén
Domain API v2 také zahrnuje operace čtení, které jsou užitečné po registraci. Endpoint List Domains podporuje stránkování, řazení, filtrování podle stavu a filtrování podle podržení, zatímco Get Domain Details vrací data registrace, data expirace, jmenné servery a kontaktní informace držitele.
Monitorování zneužití a souladu
API pro zneužití a shodu společnosti NiceNIC umožňuje vypsat domény s hlášeními o zneužití a vrátit podrobný strojově čitelný souhrn pro konkrétní doménu. Podrobný endpoint pro zneužití dokumentuje šest stavových frází na úrovni domény: Normal, Under Review, Pending ClientHold, ClientHold, Closed a ServerHold.
Odpověď může zahrnovat aktuální dopad, doporučenou další akci, stav pozastavení a časový průběh, počet stížností, data stížností, kategorie, klasifikaci zneužití DNS, stav důkazů a nahlášené URL, pokud jsou k dispozici. To umožňuje platformám a resellerům zobrazit stav souladu ve vlastních provozních systémech, místo aby se spoléhali pouze na ruční kontrolu.
Vyberte si integrační model, který odpovídá vašemu systému
| Možnost | Vhodné pro | Co poskytuje aktuální dokumentace |
|---|---|---|
| Domain API v2 | Vlastní weby, platformy SaaS, interní systémy, vlastní fakturační nebo zřizovací pracovní postupy. | Přímá integrace přes HTTPS + JSON pro operace s doménami, DNS, dětskými nameservery, účty a compliance. |
| Modul WHMCS | Hostingové společnosti a reselleri, kteří již používají WHMCS. | Dostupnost, registrace, obnovení, převod, podrobnosti o doméně, nameservery, kontakty, zámek/odemykání, získání EPP, protokolování chyb a volitelný testovací režim. |
Aktuální dokumentace WHMCS uvádí jako požadavky WHMCS 7.0 nebo vyšší, PHP 7.0 nebo vyšší s cURL, platné přihlašovací údaje k API NiceNIC a podporu SSL/TLS.
Když selže požadavek API
Začněte vrácenou odpovědí a stavem konfigurace, než abyste opakovaně zkoušeli stejnou placenou akci.
Chyba ověření nebo přístupu
- Ověřte uživatelské jméno NiceNIC a tajný klíč API.
- Ověřte, že je hlavička Authorization přítomna a správně naformátována.
- Ověřte, že tajný klíč API nebyl resetován nebo rotován.
- Pokud jsou povolena omezení IP, ověřte, že požadavek přichází z autorizované odchozí IP adresy serveru.
Chyba parametru požadavku
- Porovnejte požadavek s dokumentovanými parametry konkrétního endpointu.
- Ověřte požadované hodnoty, formáty a názvy akcí.
- V případě potřeby zkontrolujte registrační období nebo kontaktní požadavky specifické pro danou TLD.
Placená operace není dokončena okamžitě
- Přečtěte si vrácený kód
codea zprávumsg. - Nepovažujte odpověď
201(čekající) za konečné dokončení. - Před opakováním placené akce ověřte zůstatek účtu a aktuální ceny.
Potřebujete podporu NiceNIC
- Zaznamenejte časové razítko požadavku a akci API.
- Podle potřeby uveďte dotčený název domény nebo objekt.
- Uveďte vrácený kód a zprávu.
- Sdílejte pouze necitlivé parametry; nikdy do ticketu nevkládejte celý API Secret.
Začněte s bezpečným testovacím požadavkem
Povolte přístup k API, ověřte autentizaci, spusťte požadavek na dostupnost nebo cenu a před spuštěním zpoplatněných operací pro zákazníky si ověřte zpracování odpovědí.






