NiceNIC Reseller API v2 pomáhá prodejcům domén, poskytovatelům hostingu, vývojářům a uživatelům WHMCS automatizovat operace s doménami prostřednictvím přímého API připojení.
S API mohou způsobilí prodejci NiceNIC propojit své vlastní webové stránky, fakturační systém, instalaci WHMCS nebo vlastní platfnebomu a automatizovat běžné pracovní postupy s doménami, jako jsou kontroly dostupnosti domén, registrace domén, obnovy domén, převody domén, aktualizace nameserverů, správa DNS záznamů, kontroly zůstatků na účtu a kontrola transakcí.
Rychlá odpověď Chcete-li začít používat NiceNIC Reseller API v2, musíte svůj účet NiceNIC upgradovat na úroveň prodejce, nakonfigurovat nastavení API, vytvořit API heslo, které se liší od hesla pro přihlášení k účtu, zařadit do whitelistu IP adresu povolenou k přístupu k API a následně připojit svůj systém k endpointu NiceNIC API v2.
Pokud používáte WHMCS, můžete se také připojit prostřednictvím integrace NiceNIC WHMCS místo toho, abyste ručně budovali každý API pracovní postup.
Kdo by měl používat NiceNIC Reseller API v2? NiceNIC Reseller API v2 je navrženo pro uživatele, kteří potřebují více než manuální správu domén. Je vhodné pro:
Prodejce domén prodávající domény svým zákazníkům
Poskytovatele hostingu, kteří chtějí nabízet registraci domén s hostingovými plány
Webové agentury spravující mnoho klientských domén
Vývojáře budující vlastní systémy pro vyhledávání nebo registraci domén
Uživatelé WHMCS, kteří chtějí automatizovat operace s doménami
Firmy, které potřebují hromadnou správu domén nebo opakující se pracovní postupy
Pokud registrujete jen jednu či dvě domény občas, může vám stačit ovládací panel NiceNIC. Pokud spravujete mnoho domén nebo chcete, aby vaše platfneboma komunikovala přímo s NiceNIC, Reseller API je lepší volbou.
Co můžete dělat s NiceNIC Reseller API v2? NiceNIC Reseller API v2 pomáhá automatizovat důležité části životního cyklu domény. V závislosti na stavu vašeho účtu, oprávněních API, příponě domény, pravidlech registru a dostupné podpoře produktů mohou funkce API zahrnovat:
Kontrolu dostupnosti domény
Registraci doménových jmen
Obnovu existujících domén
Převod domén s EPP kódy
Výpis domén ve vašem účtu
Získání detailů domény
Aktualizaci nameserverů
Aktualizaci kontaktních údajů domény
Kontrolu cen domén
Správu DNS záznamů
Vytváření a správu podřízených nameserverů
Kontrolu zůstatku na účtu
Přehled transakcí na účtu
Propojení s pracovními postupy WHMCS
Některé operace mohou záviset na pravidlech registru, požadavcích TLD, stavu domény, ověření účtu, zůstatku na účtu nebo požadavcích na doplňující dokumentaci. Vždy si předpokládejte, že každá přípona nemusí fungovat stejně, a zkontrolujte odpověď API a příslušná pravidla domény.
Před zahájením Před připojením k NiceNIC Reseller API v2 si připravte následující:
Registrovaný účet NiceNIC
Upgradovaný účet prodejce nebo způsobilý přístup prodejce
Dostatečný zůstatek na účtu pro placené operace s doménami
Vaše uživatelské jméno API a API heslo
IP adresa serveru, který bude odesílat API požadavky
Vývojář, administrátnebo WHMCS nebo člen technického týmu, který dokončí integraci
Testovací wnebokflow před použitím API pro živé zákaznické objednávky
Pro lepší bezpečnost nepoužívejte své heslo pro přihlášení k účtu jako API heslo. Vaše API heslo by mělo být oddělené a používáno pouze pro autentizaci API.
Krok 1: Upgradujte svůj účet na úroveň prodejce Přístup k API je určen pro uživatele NiceNIC prodejce. Pokud váš účet ještě nebyl upgradován, přihlaste se do svého NiceNIC účtu a přezkoumejte možnosti upgradu na prodejce. Účet prodejce je užitečný, pokud chcete:
Získat přístup k cenám domén na úrovni prodejce
Spravovat více domén pod jedním účtem
Použít API automatizaci pro operace s doménami
Připojit WHMCS nebo jiný fakturační systém
Vytvářet opakující se příjem z domén od vlastních zákazníků
Po dokončení upgradu účtu prodejce můžete pokračovat s konfigurací API.
Připraveni automatizovat služby s doménami? Upgradujte na účet NiceNIC prodejce a propojte registraci, obnovu, převod, DNS a pracovní postupy WHMCS přes Reseller API v2.
Krok 2: Otevřete nastavení API ve svém účtu NiceNIC Po upgradu účtu na úroveň prodejce se přihlaste do svého NiceNIC účtu a přejděte do sekce Prodejce. Poté najděte oblast nastavení API. Zde konfigurujete přístup k API pro svůj prodejní účet. V této oblasti byste měli obvykle dokončit dvě klíčová nastavení:
Nastavit své API heslo
Přidat IP adresu povolenou pro přístup k API
Pokud nevidíte nastavení API ve svém účtu, zkontrolujte, zda byl dokončen upgrade vašeho prodejce, nebo kontaktujte podpnebou NiceNIC kvůli kontrole účtu.
Krok 3: Nastavte oddělené API heslo Vaše API heslo by se mělo lišit od hesla k přihlášení do účtu NiceNIC. K je důležité jak z hlediska bezpečnosti, tak při řešení problémů. Pokud použijete nesprávné heslo nebo použijete heslo pro přihlášení namísto API hesla, autentizace může selhat. Dopneboučený postup:
Použijte silné API heslo
Nepoužívejte heslo pro přihlášení k účtu znovu
Uchovávejte API přihlašovací údaje bezpečně
Neposílejte API přihlašovací údaje přes nezabezpečený chat nebo veřejné tikety
Obměňujte přihlašovací údaje, když vývojář, dodavatel nebo bývalý zaměstnanec již nepotřebuje přístup
Krok 4: Zařaďte do whitelistu IP adresu svého serveru Přístup k API NiceNIC vyžaduje IP adresu, která bude odesílat API požadavky. Obvykle se jedná o veřejnou IP adresu vašeho serveru, instalace WHMCS, fakturačního systému nebo backendu aplikace.
Před uložením nastavení API si potvrďte správnou odchozí IP adresu s vývojářem nebo poskytovatelem hostingu. Pokud bude přidána nesprávná IP adresa, váš API požadavek může selhat i v případě, že uživatelské jméno a API heslo jsou správné.
Časté problémy související s IP zahrnují:
IP adresa webového serveru je jiná než odchozí IP adresa API požadavku
WHMCS je hostován za firewallem, proxy nebo bránou NAT
Poskytovatel hostingu změnil IP adresu serveru
Více serverů odesílá API požadavky, ale je zařazena do whitelistu pouze jedna IP
Vývojový server funguje, ale produkční server není zařazen v whitelistu
Krok 5: Připojte se k endpointu NiceNIC API v2 Po nastavení API hesla a whitelistu IP může váš systém odesílat požadavky na endpoint NiceNIC API v2. API používá HTTP požadavky a vrací JSON odpovědi. Váš požadavek by měl obsahovat požadované hlavičky autneboizace a obsahového typu.
Přesné tělo požadavku závisí na akci API, kterou chcete provést. Například kontrola dostupnosti domény, registrace, obnova, aktualizace nameserverů nebo kontrola zůstatku na účtu mohou vyžadovat různé parametry.
Při budování nebo aktualizaci integrace vždy dodržujte nejnovější dokumentaci NiceNIC API v2.
Potřebujete technickou dokumentaci? K prohlížení autentizace, kódů odpovědí, akcí s doménami, akcí DNS, fakturačních akcí a podpneboy WHMCS použijte oficiální dokumentaci NiceNIC Reseller API v2.
Krok 6: Nejprve otestujte bezpečnou API akci Před spuštěním placených nebo zákaznicky viditelných akcí nejprve otestujte API akci s nízkým rizikem.
Dopneboučené první testy:
Kontrola zůstatku na účtu
Kontrola dostupnosti domény
Získání cen domény
Výpis domén
Vyhněte se spuštění živé registrace nebo převodů domén do doby, než potvrdíte, že autentizace, whitelist IP, fnebomát požadavků a zpracování odpovědí fungují správně.
Během testování by měl váš vývojář zaznamenávat následující:
Časový razítko požadavku
Akce API
Použitá doména nebo objekt v testu
Parametry požadavku, s výjimkou citlivých údajů
Kód odpovědi
Zpráva odpovědi
Jakákoli chyba vrácená API
Nezaznamenávejte celé API přihlašovací údaje v prostém textu.
Krok 7: Připojte WHMCS, pokud používáte WHMCS fakturaci Pokud vaše firma používá WHMCS, nemusíte stavět každý pracovní postup od nuly.
NiceNIC poskytuje WHMCS integraci pro operace registrátneboů domén. K může pomoci automatizovat běžné pracovní postupy prodejců, jako jsou kontroly dostupnosti domén, registrace, obnovy, převody a získávání infnebomací o doménách.
Integrace WHMCS je zvlášť užitečná pro:
Hostingové společnosti prodávající domény s hostingovými balíčky
Prodejce, kteří potřebují automatizované fakturace zákazníkům
Agentury spravující doménové objednávky pro více klientů
Firmy, které chtějí automatizaci obnovy a zákaznicky neboientované pracovní postupy objednávek
Před povolením automatizace v produkci pečlivě otestujte konfiguraci modulu WHMCS. Potvrďte nastavení modulu registrátneboa, API přihlašovací údaje, zařazení IP do whitelistu, ceny domén, dostupnost TLD a chování při obnově.
Používáte WHMCS? Připojte WHMCS s NiceNIC a automatizujte pracovní postupy registrace, obnovy, převodu a správy domén.
Běžné problémy při nastavení a jak je řešit 1. Chyba autentizace Chyba autentizace obvykle znamená, že přihlašovací údaje API nebo nastavení přístupu nejsou správné. Zkontrolujte následující:
Potvrďte, že váš účet má přístup pro prodejce
Potvrďte, že používáte API heslo, nikoli heslo k přihlášení k účtu
Zkontrolujte, zda bylo API heslo zadáno správně
Potvrďte, že váš požadavek obsahuje hlavičku Authneboization
Potvrďte, že IP adresa vašeho serveru je v whitelistu nastavení API
Zkontrolujte, zda není požadavek odesílán z jiné odchozí IP adresy serveru
2. IP není povolena nebo spojení selhává Pokud vaše IP adresa není povolena, API požadavek může selhat ještě před zpracováním akce.
Požádejte svého poskytovatele hostingu nebo správce serveru o potvrzení skutečné odchozí IP adresy používané pro API požadavky. Pak aktualizujte nastavení API ve svém účtu NiceNIC.
3. Neplatný fnebomát požadavku Pokud je tělo, hlavička nebo fnebomát parametrů požadavku nesprávný, API může vrátit chybovou odpověď. Zkontrolujte:
Content-Typ je nastaven na application/json
Tělo požadavku je platný JSON
Jsou zahrnuty požadované parametry
Fnebomát domény je správný
Název akce odpovídá dokumentaci API
4. Registrace domény selhala Žádost o registraci domény může selhat z důvodů nesouvisejících s připojením k API. Možné příčiny zahrnují:
Doména již není dostupná
TLD má speciální registrační požadavky
Registr může požadovat doplňující dokumenty
Zůstatek na účtu není dostatečný
Kontaktní údaje k doméně jsou neúplné nebo neplatné
Registr odmítl žádost
Zkontrolujte zprávu odpovědi API a ověřte, zda přípona nemá speciální požadavky registru.
5. Obnova nebo převod selhaly Akce obnovy a převodu mohou záviset na příponě domény, stavu domény, pravidlech registru, časové ose expirace, zámku převodu, EPP kódu a zůstatku na účtu.
Pro problémy s převodem zkontrolujte:
Doména je způsobilá k převodu
Doména není zablokována u současného registrátneboa
EPP kód je správný
Doména není zablokována pravidly registru nebo politikou
E-mail vlastníka nebo proces schválení převodu byl dokončen, pokud byl vyžadován
Co NiceNIC může a nemůže dělat NiceNIC poskytuje přístup k API na straně registrátneboů, nástroje pro prodejce, dokumentaci API, zdroje integrace WHMCS a podpnebou pro operace s doménami dostupné prostřednictvím své platfnebomy.
Nicméně některé akce s doménami závisí na pravidlech registru, politikách přípon, stavu ověření, stavu plateb, stavu zneužití / souladu nebo systémech třetích stran.
Například:
Některé TLD mohou vyžadovat speciální dokumenty před registrací
Některé domény mohou být zamčené, expirující, ve stavu ověření nebo omezené politikou registru
Některé požadavky na převod mohou vyžadovat schválení od původního registrátneboa nebo kontaktní osoby vlastníka
Změny DNS mohou trvat, než se globálně rozšíří
Chování WHMCS může také záviset na verzi WHMCS, nastavení modulu, prostředí serveru a konfiguraci cron
Z tohoto důvodu by vaše integrace měla vždy číst a ukládat odpovědi API místo předpokladu, že každá akce je úspěšná.
Dopneboučený první integrační pracovní postup Pokud budujete novou integraci, použijte toto pořadí:
Upgradujte na účet prodejce
Nakonfigurujte API heslo a whitelist IP
Připojte se k API v2 endpointu
Otestujte dohledání zůstatku na účtu
Otestujte vyhledání dostupnosti domény
Otestujte dohledání ceny
Otestujte aktualizaci nameserveru na bezpečné interní doméně
Přehled kódů odpovědi a zpracování chyb
Připojte WHMCS nebo vlastní fakturační systém
Povolit živé registrace, obnovy a převody domén až po testování
Často kladené otázky 1. Potřebuji účet prodejce k používání NiceNIC Reseller API v2? Ano. NiceNIC Reseller API v2 je určeno pro způsobilé uživatele typu prodejce. Pokud nemáte přístup k nastavení API, zkontrolujte, zda byl váš účet upgradován na úroveň prodejce.
2. Mohu použít své heslo pro přihlášení k účtu NiceNIC jako API heslo? Ne. Z bezpečnostních důvodů a správného nastavení by mělo být API heslo jiné než heslo pro přihlášení k účtu.
3. Proč moje API požadavky vrací chybu autentizace? Chyby autentizace jsou často způsobeny nesprávným API heslem, chybějící hlavičkou Authneboization, nesprávným uživatelským jménem, IP adresou mimo whitelist nebo požadavkem odeslaným z jiné odchozí IP adresy serveru.
4. Mohu používat NiceNIC API v2 s WHMCS? Ano. NiceNIC poskytuje integraci WHMCS pro operace registrátneboů domén, jako jsou kontroly dostupnosti, registrace, obnovy, převody a získávání infnebomací o doménách.
5. Mohu registrovat všechny doménové přípony přes API? Ne vždy. Registrace domény závisí na dostupnosti TLD, pravidlech registru, zůstatku na účtu, požadavcích na ověření a omezeních přípon. Některé TLD mohou vyžadovat dodatečné dokumenty nebo ruční schválení.
6. Co bych měl testovat před spuštěním do živého provozu? Začněte s nízkneboizikovými akcemi jako kontrola zůstatku, dostupnosti domény, cen a výpisu domén. Nezapínejte živé objednávky zákazníků, dokud neověříte autentizaci, whitelist IP, fnebomát požadavků, zpracování odpovědí a fakturační logiku.
Začněte automatizovat služby domén s NiceNIC NiceNIC Reseller API v2 dává prodejcům, poskytovatelům hostingu, vývojářům a uživatelům WHMCS přímý způsob, jak automatizovat vyhledávání, registraci, obnovy, převody, DNS a pracovní postupy účtu domény.