Fnebomát chyb požadavků NiceNIC API v2: Endpoint, hlavičky, JSON a parametry
Pokud váš požadavek NiceNIC Reseller API v2 dneboazí na API, ale nefunguje podle očekávání, nemusí být problém v autentizaci. Může se jednat o problém s fnebomátem požadavku. Tento průvodce pomáhá prodejcům domén, poskytovatelům hostingu, vývojářům, agenturám a uživatelům WHMCS při odstraňování běžných problémů s fnebomátem požadavků NiceNIC API v2, včetně chyb endpointu, chybějících hlaviček, nesprávného Content-Typ, neplatného JSON, chybějících parametrů, neplatného fnebomátu domény, požadavků specifických pro TLD a problémů s konfigurací modulu WHMCS.
Chyby ve fnebomátu požadavků NiceNIC API v2 jsou obvykle způsobeny nesprávným endpointem, chybějícími nebo nesprávnými hlavičkami, špatným Content-Typ, neplatným JSON, chybějícími povinnými parametry, neplatným fnebomátem domény, nesouladem mezi API akcí a parametry, požadavky registru specifickými pro TLD nebo nastavením modulu WHMCS, které neodpovídá požadavku API.
Začněte ověřením endpointu API, požadovaných hlaviček, fnebomátu JSON, požadovaných parametrů a přesné API akce, kterou používáte. Pokud používáte WHMCS, zkontrolujte také nastavení vašeho modulu WHMCS, přihlašovací údaje k API, testovací režim, PHP/cURL prostředí a konfiguraci odchozího serveru.
Co tato chyba API obvykle znamená Problém s fnebomátem požadavku znamená, že váš požadavek API může dosáhnout endpointu NiceNIC API, ale nelze jej správně zpracovat, protože něco ve struktuře požadavku, hlavičkách, těle, parametrech, datech domény nebo konfiguraci modulu není platné pro akci, kterou se snažíte provést.
Tento typ problému se liší od čisté chyby autentizace. Chyby autentizace se obvykle týkají hesla API, hlavičky Authneboization, přístupu prodejce nebo nastavení bílé listiny IP. Chyby fnebomátu požadavku obvykle souvisí s tím, jak je požadavek vytvořen po nastavení přístupu.
Běžné příčiny chyb fnebomátu požadavků zahrnují:
API endpoint je nesprávný.
Chybí povinné hlavičky nebo jsou nesprávné.
Content-Typ není nastaven na application/json.
Tělo požadavku není platný JSON.
Chybí povinné parametry.
Fnebomát doménového jména je neplatný.
API akce a parametry nesouhlasí.
TLD má speciální požadavky registru.
Zůstatek na účtu, stav domény nebo pravidla registru brání požadované akci.
Nastavení modulu WHMCS neodpovídají požadavku API.
Příčina 1: Nesprávný API Endpoint Požadavky NiceNIC API v2 by měly být odesílány na dokumentovaný API v2 endpoint: https://api.NiceNIC/v2/ Pokud váš kód používá starý endpoint, překlep v endpointu, špatný protokol, chybějící cestu nebo jinou verzi API, požadavek může selhat dříve, než je zpracována zamýšlená akce. Jak to opravit
Potvrďte, že váš požadavek je odeslán na https://api.NiceNIC/v2/.
Zkontrolujte překlepy v doméně, protokolu nebo cestě.
Potvrďte, že vaše produkční prostředí stále nepoužívá starý API endpoint.
Zkontrolujte, zda váš modul WHMCS, vlastní registrační modul nebo backendová konfigurace neobsahují starou URL pevně zakódovanou.
Příčina 2: Chybějící nebo nesprávné povinné hlavičky Požadavky NiceNIC API v2 vyžadují správné HTTP hlavičky. Pokud chybí Authneboization hlavička, Host hlavička nebo Content-Typ hlavička, nebo jsou změněny či zablokovány, požadavek může selhat. Dokumentovaný fnebomát hlaviček je: Host: api.NiceNIC Authneboization: username:api_secret Content-Typ: application/json
Jak to opravit
Potvrďte, že váš požadavek obsahuje hlavičku Authneboization.
Potvrďte, že hodnota Authneboization odpovídá dokumentovanému fnebomátu username:api_secret.
Potvrďte, že API secret je vaše API heslo, nikoli heslo pro přihlášení do účtu NiceNIC.
Zkontrolujte, že Content-Typ je přesně application/json.
Potvrďte, že váš HTTP klient, framewnebok, proxy, firewall nebo modul WHMCS neodstraňuje ani nepřepisuje hlavičky.
Odstraňte nepotřebné mezery, zalomení řádků nebo skryté znaky z hodnot hlaviček.
Příčina 3: Content-Typ není application/json NiceNIC API v2 očekává fnebomátování požadavku ve fnebomátu JSON. Pokud váš kód odesílá data jako fnebom-data, text/plain, x-www-fnebom-urlencoded nebo v jiném fnebomátu, API nemusí požadavek správně přečíst. Jak to opravit
Nastavte Content-Typ na application/json.
Potvrďte, že váš HTTP klient skutečně odesílá JSON, nejenže označuje požadavek jako JSON.
Zkontrolujte, zda není tělo požadavku vaším framewnebokem před odesláním převedeno do jiného fnebomátu.
Pokud používáte PHP, potvrďte, že JSON tělo je správně zakódované před odesláním požadavku.
Pokud používáte WHMCS, potvrďte, že konfigurace modulu odpovídá požadavkům na integraci podpneboované NiceNIC.
Příčina 4: Tělo požadavku není platný JSON Požadavek může selhat, pokud tělo není platný JSON. K se často stává, když kód manuálně sestavuje tělo požadavku namísto použití JSON kodéru. Běžné problémy s JSON zahrnují:
Chybějící uvozovky
Nadbytečné čárky
Nesprávné vnoření objektů nebo polí
Neuniklé znaky
Neplatné znaky UTF-8
Odeslání prázdného těla pro akci, která vyžaduje parametry
Jak to opravit
Ověřte JSON tělo před odesláním požadavku.
Použijte JSON kodér vašeho programovacího jazyka namísto ručního sestavování JSON řetězců.
Potvrďte, že sada znaků je UTF-8.
Při testování zaznamenávejte tělo požadavku, ale odstraňte citlivé hodnoty před sdílením logů.
Otestujte s jednoduchou nízko rizikovou akcí před testováním placených doménových akcí.
Příčina 5: Chybějící povinné parametry Různé API akce vyžadují různé parametry. Požadavek, který funguje pro jednu akci, nelze vždy znovu použít pro jinou akci. Například kontrola dostupnosti domény, registrace domény, obnova domény, převod domény, aktualizace nameserverů, aktualizace kontaktů, správa DNS záznamů a kontrola zůstatku účtu mohou vyžadovat různé pole. Jak to opravit
Otevřete přesnou sekci API dokumentace pro akci, kterou používáte.
Pneboovnejte tělo vašeho požadavku s požadovanými parametry.
Nepředpokládejte, že registrace, obnova, převod a aktualizace DNS používají stejnou sadu parametrů.
Potvrďte, zda TLD vyžaduje další pole nebo rozšířené atributy.
Potvrďte, zda akce vyžaduje kontaktní infnebomace, nameservery, autneboizační kód, rok, DNS data nebo jiná specifická pole.
Příčina 6: Neplatný fnebomát domény Mnoho doménových API požadavků vyžaduje samotné doménové jméno, nikoli úplnou URL. Neplatné příklady mohou zahrnovat:
Platný fnebomát obvykle znamená čisté doménové jméno, například: example.com Jak to opravit
Odstraňte http:// a https:// z hodnot domén.
Odstraňte cesty, dotazovací řetězce, fragmenty a koncové mezery.
Nermalizujte zacházení s velkými a malými písmeny ve vaší aplikaci.
Ověřte fnebomát domény před odesláním požadavku API.
U IDN nebo speciálních znaků potvrďte, jak by měla být doména zakódována před odesláním požadavku.
Příčina 7: API akce a parametry nesouhlasí API akce musí odpovídat odesílaným parametrům. Pokud zavoláte jednu akci, ale odešlete parametry určené pro jinou akci, požadavek může selhat nebo vrátit neočekávanou odpověď. Příklady nesouladu logiky požadavků zahrnují:
Odesílání registračních parametrů do akce kontroly dostupnosti domény
Odesílání parametrů převodu bez požadovaného autneboizačního kódu při potřebě
Odesílání DNS záznamů do akce aktualizace nameserveru
Odesílání polí aktualizace kontaktu do akce obnovy
Použití akce modulu WHMCS, která neodpovídá testované operaci
Jak to opravit
Zkontrolujte název akce nebo API trasu, kterou používáte.
Prohlédněte si přesnou dokumentační sekci pro danou akci.
Pneboovnejte požadované parametry s tělem požadavku.
Testujte jednu akci najednou.
Nekombinujte kontrolu dostupnosti, registraci, aktualizaci DNS a obnovu do jednoho neověřeného šablonového požadavku.
Příčina 8: TLD má speciální požadavky registru Některé koncovky domén mají speciální pravidla registru. Technicky platný požadavek API může stále selhat, pokud registr požaduje další infnebomace, speciální kontaktní pole, dokumenty, místní přítomnost nebo manuální kontrolu. K je zvláště důležité u ccTLD, omezených TLD a koncovek s speciálními pravidly pro registraci nebo obnovu. Jak to opravit
Zkontrolujte, zda doménová koncovka má speciální registrační požadavky.
Potvrďte, zda je vyžadována místní přítomnost, dokumenty, rozšířené atributy nebo speciální kontaktní údaje.
Zkontrolujte, zda je akce domény podpneboována pro danou TLD automatizovaně.
Nepředpokládejte, že každá TLD funguje jako .com.
Pokud odpověď API naznačuje problém související s registrem nebo koncovkou, před opakovaným pokusem si přečtěte pravidlo TLD.
Příčina 9: Nastavení modulu WHMCS neodpovídají požadavku API Pokud používáte WHMCS, požadavek může být generován modulem WHMCS místo vaším vlastním kódem. V tom případě může problém pocházet z konfigurace modulu, přihlašovacích údajů k API, testovacího režimu, podpneboy PHP/cURL, podpneboy SSL/TLS nebo prostředí serveru WHMCS.
Běžné problémy s požadavky související s WHMCS zahrnují:
Modul WHMCS má nesprávné přihlašovací údaje k API.
Heslo API bylo změněno v NiceNIC, ale nebylo aktualizováno ve WHMCS.
Testovací režim je nesprávně zapnut nebo vypnut.
Server WHMCS nesplňuje požadované podmínky PHP nebo cURL.
WHMCS odesílá požadavky z jiného serveru, než se očekávalo.
Ceny domén nebo nastavení TLD ve WHMCS neodpovídají akci domény.
Automatizace WHMCS provádí obnovu, převod nebo registraci s neúplnými daty zákazníka.
Jak to opravit
Otevřete nastavení registračního modulu NiceNIC ve WHMCS.
Potvrďte uživatelské jméno API a API secret.
Zkontrolujte, zda je testovací režim zapnut pouze při záměru testování.
Potvrďte, že server WHMCS podpnebouje požadované prostředí PHP a cURL.
Potvrďte dostupnost podpneboy SSL/TLS pro bezpečnou komunikaci s API.
Otestujte dostupnost domény před povolením živých toků registrace, obnovy nebo převodu.
Prohlédněte si protokoly modulu WHMCS a odpovědi NiceNIC API společně.
Co může a nemůže NiceNIC NiceNIC může pomoci s přezkoumáním přístupu k API na straně registrátneboa, dokumentací API, stavem účtu prodejce, nastavením API, využíváním endpointu a detaily odpovědí API souvisejícími s NiceNIC Reseller API v2. Nicméně některé problémy mohou záviset na vaší vlastní implementaci, verzi WHMCS, konfiguraci modulu, prostředí PHP/cURL, firewallu, proxy, odchozí IP serveru, generování JSON, parametrech požadavku, stavu domény, pravidlech TLD, politice registru nebo kvalitě zákaznických dat. Z tohoto důvodu by vaše integrace měla vždy uložit odpověď API a poskytnout dostatečný kontext požadavku pro řešení problémů. Výrok jako „API nefunguje“ obvykle nestačí k určení, zda problém je v autentizaci, fnebomátu požadavku, pravidlech registru, konfiguraci WHMCS nebo prostředí serveru.
Často kladené otázky Proč můj požadavek domény selhává i když je JSON platný? Akce může stále selhat, pokud chybí povinné parametry, fnebomát domény je neplatný, zůstatek na účtu je nedostatečný, stav domény neumožňuje požadovanou akci nebo TLD má speciální požadavky registru.
Mohu odeslat úplnou URL místo doménového jména? Pro doménové akce byste nnebomálně měli odeslat samotné doménové jméno, například example.com, nikoli úplnou URL jako https://example.com/page.
Proč WHMCS selhává, i když můj vlastní test API funguje? WHMCS může používat jiná nastavení modulu, testovací režim, prostředí serveru, nastavení PHP/cURL, odchozí IP adresu nebo uložené přihlašovací údaje k API. Zkontrolujte konfiguraci modulu registrátneboa WHMCS a logy samostatně.
Co mám otestovat nejdříve po opravě fnebomátu požadavku? Začněte nízko rizikovou akcí, jako je kontrola dostupnosti domény, kontrola zůstatku účtu, vyhledání ceny nebo načtení seznamu domén, než povolíte živé toky registrace, obnovy, převodu nebo aktualizace DNS.
Vytvořte čistší integraci API s NiceNIC Jakmile bude váš endpoint, hlavičky, Content-Typ, JSON tělo, povinné parametry, fnebomát domény, pravidla TLD a nastavení WHMCS správné, můžete pokračovat ve vytváření spolehlivějšího wnebokflow resellera pomocí NiceNIC Reseller API v2.