Nejčastější dotazy k NiceNIC API pro domény v2

NiceNIC Domain API v2 je rozhraní API založené na HTTPS a JSON, které slouží k automatizaci správy domén prostřednictvím vašeho účtu NiceNIC.

Podporuje základní pracovní postupy, včetně kontroly dostupnosti domén, registrace, obnovení, převodu, dotazů na portfolia, aktualizací jmenných serverů a kontaktů, cen, DNS záznamů, dětských jmenných serverů, informací o účtu a operací souvisejících s plněním požadavků.

API použijte, pokud chcete připojit služby domén NiceNIC přímo k webu, hostingové platformě, fakturačnímu systému, internímu nástroji nebo jiné aplikaci.

Jakýkoli aktivní účet NiceNIC může používat Domain API v2. Přístup k API je k dispozici jak pro tržní účty, tak pro účty prodejců.

K získání přístupu k API se nemusíte stát prodejcem. Typ účtu však stále ovlivňuje ceny: placené operace API používají ceny přiřazené účtu NiceNIC, který požadavek odesílá.

Otevřít nastavení API →

Ano. Samotný přístup k API je zdarma. Neexistuje žádný samostatný poplatek za povolení přístupu k API ani za odesílání podporovaných požadavků API.

Zpoplatněné operace, jako je registrace domény, prodloužení a převod, jsou účtovány podle cen vašeho účtu a platných pravidel pro domény.

Ne. Přístup k API a ceny pro resellery jsou oddělené.

Domain API v2 můžete používat s běžným účtem NiceNIC Market Account. Na účet resellera přejděte pouze tehdy, když jsou pro váš objem obchodů užitečné ceny pro resellery nebo jiné výhody pro resellery.

Porovnat plány pro resellery →

Domain API v2 používá aktuální strukturu NiceNIC API s požadavky HTTPS, odpověďmi JSON, autentizací na základě hlaviček a dokumentací uspořádanou podle jednotlivých pracovních postupů pro domény a účty.

Pokud spravujete integraci postavenou na starším NiceNIC API, před převedením produkčního provozu zkontrolujte parametry API v2 a zpracování odpovědí, a nepředpokládejte, že jsou tyto dvě verze zaměnitelné.

Přihlaste se ke svému účtu NiceNIC a otevřete API Settings. Požadavky API v2 používají k autentizaci vaše uživatelské jméno NiceNIC a API Secret.

Otevřít nastavení API →

Ano. NiceNIC poskytuje API Sandbox pro vývojáře, aby mohli otestovat integrace před jejich připojením k produkčnímu API.

Použijte Sandbox k ověření autentizace, formátování požadavků, zpracování odpovědí, zpracování chyb a vašeho aplikačního pracovního postupu před povolením živých zákaznických doménových operací.

Otevřít API Sandbox →

API Sandbox je určen pro vývoj a integrační testování. Produkční API se používá pro živé doménové operace a placené požadavky proti vašemu účtu NiceNIC.

Doporučujeme ověřit autentizaci, zpracování požadavků, zpracování odpovědí a logiku chyb v Sandboxu před povolením produkčních operací orientovaných na zákazníky.

Odesílejte požadavky API přes HTTPS a do hlavičky Authorization zahrňte své uživatelské jméno NiceNIC a API Secret.

Host: api.nicenic.net
Authorization: username:api_secret
Content-Type: application/json

Pokud jsou pro váš účet povolena omezení IP, musí požadavky přicházet také z autorizované IP adresy serveru.

Přečtěte si API autentizaci →

Základní endpoint produkčního API je:

https://api.nicenic.net/v2/

Akce rozhraní API se vybírají pomocí parametrů dokumentovaných pro každý endpoint, jako jsou category a action. Vždy se řiďte věnovanou dokumentací endpointu pro povinné a volitelné parametry konkrétní operace.

Odpovědi API v2 používají JSON a parametry požadavků používají UTF-8.

{
  "code": 0,
  "msg": "success",
  "data": {}
}

Vaše aplikace by měla zkontrolovat vrácené code a msg spíše než předpokládat, že každá odpověď HTTP představuje dokončenou operaci s doménou.

Prostřednictvím aktuálně zdokumentovaných API můžete automatizovat pracovní postupy, včetně kontroly dostupnosti domén, registrace, obnovení a převodu domén, výpisu portfolia a podrobností o doménách, aktualizací jmenných serverů a kontaktů domén, cen domén, DNS záznamů, dětských jmenných serverů, informací o účtu a monitoringu zneužití a souladu s předpisy.

Další pracovní postupy jsou jednotlivě zdokumentovány v navigaci API.

Začněte s nízko rizikovými operacemi pro čtení, jako je kontrola dostupnosti domén, ceny domén, zůstatek na účtu a výpis domén.

Poté ověřte autentizaci, zpracování odpovědí, zpracování chyb a zpracování čekajících objednávek před povolením ostrých registrací, obnovení nebo převodů.

Ano. Endpoint Check Domain Availability podporuje více doménových jmen oddělených čárkami.

example.com,example.net,example.org

Nepředpokládejte, že každá API operace podporuje stejný formát pro zadání více domén. Registrace, obnovení a převod by se měly řídit dokumentací svého příslušného endpointu.

Použijte koncový bod Získání cen domén. Dokumentované typy cen zahrnují register, renew, transfer a all.

Odpovědi na registraci mohou také obsahovat hodnotu is_premium udávající, zda je dotazovaná registrace prémiová.

Vzhledem k tomu, že objednávky API používají ceny na úrovni účtu, zjistěte si aktuální ceny před odesláním placených objednávek zákazníků, místo abyste se trvale spoléhali na uložené ceny.

Ne. I když dokumentace API podporuje období až 1–10 let pro příslušné koncovky, jednotlivé TLD mohou mít odlišná pravidla registru.

Délka registrace, délka obnovení, způsobilost k převodu, kontaktní požadavky a požadavky na ověření se mohou lišit podle koncovky. Vaše aplikace by měla dodržovat aktuální pravidla pro danou TLD.

Jedná se o samostatné operace a neměly by být považovány za zaměnitelné.

Při určování stavu požadavku API vždy používejte vrácený kód a zprávu.

Zobrazit kódy odpovědí API →

Odpověď 201 znamená, že operace byla přijata ke zpracování, ale nemusí nutně dosáhnout konečného stavu.

U registrace domény odpověď 201 znamená, že objednávka byla odeslána a čeká na konečné zpracování v registru.

Neříkejte koncovému zákazníkovi, že je doména aktivní, dokud váš systém nepotvrdí konečný výsledek. Postupujte podle dokumentace registračního endpointu, kde najdete aktuální pravidla pro čekající objednávky a vrácení plateb.

Čekající převod znamená, že požadavek na převod byl přijat ke zpracování, ale doména ještě nebyla dokončena převedena na NiceNIC.

Dokončení převodu může záviset na zpracování registrem a registrátorem a také na aktuálním stavu převodu domény. Ponechte převod ve stavu čekající, dokud nebude potvrzeno jeho dokončení.

Ano. API List Domains podporuje načítání portfolia s možnostmi stránkování, řazení a filtrování.

Pokud potřebujete podrobné informace o jednotlivé doméně, jako jsou údaje o registraci, informace o vypršení platnosti, jmenné servery a kontaktní údaje domény, použijte Get Domain Details.

NiceNIC Domain API v2 zahrnuje operace pro zneužití a compliance, určené pro platformy a resellery, kteří spravují portfolia domén zákazníků.

Můžete identifikovat domény spojené s hlášeními o zneužití a získat strojově čitelné informace o shodě pro jednotlivé domény. V závislosti na případu může odpověď obsahovat stav domény, aktuální dopad, doporučené opatření, informace o pozastavení, informace o stížnosti a nahlášené URL.

To umožňuje zobrazit stav shody přímo ve vašem vlastním zákaznickém portálu nebo provozním systému.

Ano. NiceNIC poskytuje integraci registrátora WHMCS pro společnosti, které již používají WHMCS pro fakturaci a zřizování služeb.

Použijte přímé Domain API v2, pokud vytváříte vlastní aplikaci nebo pracovní postup. Použijte integraci WHMCS, pokud chcete integrovat doménové operace do stávajícího prostředí WHMCS.

Zobrazit integraci WHMCS →

Jakýkoli serverový programovací jazyk nebo běhové prostředí schopné odesílat HTTPS požadavky a zpracovávat JSON lze integrovat s Domain API v2.

Mezi běžné volby patří PHP, Python, Node.js a Java. Uchovávejte přihlašovací údaje k API na straně serveru a nikdy nevystavujte svůj API Secret v JavaScriptu na straně prohlížeče nebo ve stahovatelném klientském kódu.

Omezení rychlosti může být uplatněno za účelem ochrany stability API a bezpečnosti platformy.

Pokud se očekává, že vaše produkční integrace bude generovat trvale vysoký objem požadavků, kontaktujte NiceNIC před spuštěním, aby bylo možné posoudit váš očekávaný způsob využití.

Uveďte časové razítko požadavku, kategorii API a akci, název domény tam, kde je to relevantní, necitlivé parametry požadavku, vrácený kód odpovědi a zprávu, a zda požadavek pocházel z prostředí Sandbox nebo Production.

Odeslat tiket →

Použijte navigaci API v dokumentaci. Každá operace má vlastní stránku s podporovanými parametry, příklady požadavků, příklady odpovědí a chováním specifickým pro danou operaci.

Časté dotazy vysvětlují obecné chování API; dokumentace jednotlivých koncových bodů by měla být považována za zdroj pravdy pro přesný formát požadavku.

Otevřít dokumentaci API →