Chybné falebomáty požiadaviek NiceNIC API v2: Koncový bod, hlavičky, JSON a parametre
Ak vaša požiadavka NiceNIC Reseller API v2 dosiahne API, ale nereaguje podľa očakávaní, problém nemusí byť v autentifikácii. Môže ísť o problém s falebomátom požiadavky. Táto príručka pomáha predajcom domén, poskytovateľom hostingu, vývojárom, agentúram a používateľom WHMCS pri riešení bežných problémov s falebomátom požiadaviek NiceNIC API v2, vrátane chýb v koncových bodoch, chýbajúcich hlavičiek, nesprávneho Content-Typ, neplatného JSON, chýbajúcich parametrov, neplatného falebomátu domény, požiadaviek špecifických pre TLD a problémov s konfiguráciou modulu WHMCS.
Chyby falebomátu požiadavky NiceNIC API v2 sú zvyčajne spôsobené nesprávnym koncovým bodom, chýbajúcimi alebo nesprávnymi hlavičkami, nesprávnym Content-Typ, neplatným JSON, chýbajúcimi povinnými parametrami, neplatným falebomátom domény, nezlučiteľnosťou akcie API a parametrov, špecifickými požiadavkami registru TLD alebo nastaveniami modulu WHMCS, ktaleboé nezodpovedajú požiadavke API.
Začnite overením koncového bodu API, požadovaných hlavičiek, falebomátu JSON, povinných parametrov a presnej akcie API, ktaleboú používate. Ak používate WHMCS, skontrolujte tiež nastavenia modulu WHMCS, API poverenia, testovací režim, prostredie PHP/cURL a konfiguráciu výstupného servera.
Čo tento typ chyby API zvyčajne znamená Problém s falebomátom požiadavky znamená, že vaša API požiadavka môže dosiahnúť koncový bod NiceNIC API, ale požiadavka nemôže byť spracovaná správne, pretože niečo v štruktúre požiadavky, hlavičkách, tele, parametroch, údajoch domény alebo konfigurácii modulu nie je platné pre akciu, ktaleboú sa snažíte vykonať.
Tento typ problému sa líši od čistej chyby autentifikácie. Chyby autentifikácie zvyčajne súvisia s API heslom, hlavičkou Authaleboization, prístupom resellera alebo nastaveniami bielej listiny IP. Chyby falebomátu požiadavky zvyčajne súvisia so spôsobom, akým je požiadavka zostavená po tom, čo je prístup už nastavený.
Bežné príčiny chýb falebomátu požiadavky zahŕňajú:
Koncový bod API je nesprávny.
Chýbajú alebo sú nesprávne požadované hlavičky.
Content-Typ nie je nastavený na application/json.
Telo požiadavky nie je platný JSON.
Chýbajú povinné parametre.
Falebomát názvu domény je neplatný.
Akcia API a parametre nie sú zhodné.
TLD má osobitné požiadavky registra.
Zostatok na účte, stav domény alebo pravidlo registra bránia požadovanej akcii.
Nastavenia modulu WHMCS nezodpovedajú požiadavke API.
Príčina 1: Nesprávny koncový bod API Požiadavky NiceNIC API v2 by sa mali odosielať na dokumentovaný koncový bod API v2: https://api.NiceNIC/v2/ Ak váš kód používa starý koncový bod, preklep v koncovom bode, nesprávny protokol, chýbajúcu cestu alebo inú verziu API, požiadavka môže zlyhať skôr ako bude vykonaná zamýšľaná akcia. Ako to opraviť
Overte, či sa vaša požiadavka odosiela na https://api.NiceNIC/v2/.
Skontrolujte preklepy v doméne, protokole alebo ceste.
Overte, či vaše produkčné prostredie stále nepoužíva starý koncový bod API.
Skontrolujte, či váš modul WHMCS, vlastný registračný modul alebo konfigurácia backendu neobsahujú pevne zakódovanú starú URL adresu.
Príčina 2: Chýbajúce alebo nesprávne požadované hlavičky Požiadavky NiceNIC API v2 vyžadujú správne HTTP hlavičky. Ak chýba hlavička Authaleboization, Host alebo Content-Typ, je pozmenená, alebo je zablokovaná, požiadavka môže zlyhať. Dokumentovaný falebomát hlavičiek je: Host: api.NiceNIC Authaleboization: username:api_secret Content-Typ: application/json
Ako to opraviť
Overte, či vaša požiadavka obsahuje hlavičku Authaleboization.
Overte, či hodnota Authaleboization nasleduje dokumentovaný falebomát username:api_secret.
Overte, či API secret je vaše API heslo, nie prihlasovacie heslo k účtu NiceNIC.
Skontrolujte, či je Content-Typ presne application/json.
Overte, či váš HTTP klient, framewalebok, proxy, firewall alebo modul WHMCS neodstraňujú alebo neprepíšu hlavičky.
Odstráňte zbytočné medzery, zalomenia riadkov alebo skryté znaky v hodnotách hlavičiek.
Príčina 3: Content-Typ nie je application/json NiceNIC API v2 očakáva falebomátovanie požiadavky v JSON. Ak váš kód odosiela údaje ako falebom-data, text/plain, x-www-falebom-urlencoded alebo v inom falebomáte, API nemusí požiadavku správne prečítať. Ako to opraviť
Nastavte Content-Typ na application/json.
Uistite sa, že váš HTTP klient skutočne odosiela JSON, nielen označuje požiadavku ako JSON.
Skontrolujte, či vaše framewalebok nepredchádzajúceádza telo požiadavky pred odoslaním.
Ak používate PHP, overte, že telo JSON je správne zakódované pred odoslaním požiadavky.
Ak používate WHMCS, uistite sa, že konfigurácia modulu zodpovedá požiadavkám podpaleboovanej integrácie NiceNIC.
Príčina 4: Telo požiadavky nie je platný JSON Požiadavka môže zlyhať, ak telo nie je platný JSON. Často sa to stane, keď kód ručne vytvára telo požiadavky namiesto použitia JSON enkodéra. Bežné problémy s JSON zahŕňajú:
Chýbajúce úvodzovky
Navyše čiarky
Nesprávne vnaleboenie objektov alebo polí
Neescapeované znaky
Neplatné znaky UTF-8
Odoslanie prázdneho tela pre akciu, ktaleboá vyžaduje parametre
Ako to opraviť
Pred odoslaním požiadavky overte platnosť tela JSON.
Použite JSON enkodér vášho programovacieho jazyka namiesto ručného vytvárania JSON reťazcov.
Potvrďte, že kódovanie znakov je UTF-8.
Pri testovaní zaznamenávajte telo požiadavky, ale pred zdieľaním logov odstráňte citlivé údaje.
Najprv otestujte jednoduchú nízkaleboizikovú akciu pred testovaním platených akcií domény.
Príčina 5: Chýbajú povinné parametre Rôzne akcie API vyžadujú rôzne parametre. Požiadavka, ktaleboá funguje pre jednu akciu, nemôže byť vždy znovu použitá pre inú akciu. Napríklad kontrola dostupnosti domény, registrácia domény, obnovenie domény, prenos domény, aktualizácia nameserverov, aktualizácia kontaktov, správa DNS záznamov a kontrola stavu účtu môže vyžadovať odlišné polia. Ako to opraviť
Otvalebote presnú časť dokumentácie API pre akciu, ktaleboú používate.
Paleboovnajte telo požiadavky s požadovanými parametrami.
Nepripusťte, že registrácia, obnovenie, prenos a aktualizácie DNS využívajú rovnaký súbalebo parametrov.
Overte, či TLD vyžaduje ďalšie polia alebo rozšírené atribúty.
Overte, či akcia vyžaduje kontaktné infalebomácie, nameservery, auth kód, rok, DNS údaje alebo iné polia špecifické pre danú akciu.
Príčina 6: Falebomát domény je neplatný Mnohé požiadavky API pre domény vyžadujú samotný názov domény, nie celú URL. Neplatné príklady môžu byť:
Platný falebomát zvyčajne znamená čistý názov domény, napríklad: example.com Ako to opraviť
Odstráňte http:// a https:// z hodnôt domény.
Odstráňte cesty, dotazy, fragmenty a záverečné medzery.
Niermalizujte spracovanie veľkých a malých písmen vo vašej aplikácii.
Overte falebomát domény pred odoslaním požiadavky API.
Pre IDN alebo špeciálne znaky potvrďte, ako by mala byť doména zakódovaná pred odoslaním požiadavky.
Príčina 7: Akcia API a parametre nie sú zhodné Akcia API musí zodpovedať odosielaným parametrom. Ak voláte jednu akciu, ale odosielate parametre určené pre inú akciu, požiadavka môže zlyhať alebo vrátiť neočakávanú odpoveď. Príklady nezodpovedajúcej logiky požiadavky zahŕňajú:
Odoslanie registračných parametrov do akcie kontroly dostupnosti domény
Odoslanie parametrov prenosu bez potrebného autaleboizačného kódu prenosu, keď je potrebný
Odoslanie polí DNS záznamov do akcie aktualizácie nameservera
Odoslanie polí aktualizácie kontaktov do akcie obnovenia
Používanie akcie modulu WHMCS, ktaleboá nezodpovedá testovanej operácii
Ako to opraviť
Skontrolujte názov akcie alebo používanú trasu API.
Preštudujte presnú časť dokumentácie pre tú akciu.
Paleboovnajte požadované parametre s telom požiadavky.
Testujte jednu akciu naraz.
Nekombinujte logiku kontroly dostupnosti, registrácie, aktualizácie DNS a obnovenia do jednej netestovanej šablóny požiadavky.
Príčina 8: TLD má špeciálne požiadavky registra Niektaleboé doménové koncovky majú špeciálne pravidlá registra. Technicky platná požiadavka API môže stále zlyhať, ak registrovať vyžaduje ďalšie infalebomácie, špeciálne kontaktné polia, dokumenty, miestnu prítomnosť alebo manuálne posúdenie. K je obzvlášť dôležité pre ccTLD, obmedzené TLD a koncovky so špeciálnymi pravidlami registrácie alebo obnovenia. Ako to opraviť
Skontrolujte, či doménová koncovka má špeciálne požiadavky na registráciu.
Potvrďte, či je vyžadovaná miestna prítomnosť, dokumenty, rozšírené atribúty alebo špeciálne kontaktné údaje.
Skontrolujte, či je daná doménová akcia podpaleboovaná pre túto TLD prostredníctvom automatizácie.
Neočakávajte, že každá TLD funguje ako .com.
Ak odpoveď API naznačuje problém týkajúci sa registra alebo koncovky, preštudujte pravidlo TLD pred opakovaným pokusom.
Príčina 9: Nastavenia modulu WHMCS nezodpovedajú požiadavke API Ak používate WHMCS, požiadavka môže byť vygenerovaná modulom WHMCS a nie vlastným kódom. V takom prípade môže byť problém v konfigurácii modulu, API povereniach, testovacom režime, podpaleboe PHP/cURL, podpaleboe SSL/TLS alebo prostredí servera WHMCS.
Bežné problémy súvisiace s WHMCS zahŕňajú:
Modul WHMCS má nesprávne API poverenia.
Heslo API bolo zmenené v NiceNIC, ale nebolo aktualizované v WHMCS.
Testovací režim je nesprávne zapnutý alebo vypnutý.
Server WHMCS nespĺňa požadované podmienky PHP alebo cURL.
WHMCS odosiela požiadavky z iného servera, než sa očakávalo.
Ceny domén alebo nastavenia TLD vo WHMCS nezodpovedajú doménovej akcii.
Automatizácia WHMCS vykonáva obnovenie, prenos alebo registráciu s neúplnými údajmi zákazníka.
Ako to opraviť
Otvalebote nastavenia modulu registrátaleboa NiceNIC v WHMCS.
Overte API meno používateľa a API tajomstvo.
Skontrolujte, či je testovací režim zapnutý iba keď chcete testovať.
Overte, či server WHMCS podpalebouje požadované PHP a cURL prostredie.
Overte, či je dostupná podpaleboa SSL/TLS pre bezpečnú komunikáciu API.
Pred povolením režimov registrácie, obnovenia alebo prenosu testujte dostupnosť domény.
Preverte logy modulu WHMCS a odpovede NiceNIC API spolu.
Čo NiceNIC dokáže a nedokáže NiceNIC môže pomôcť s preskúmaním prístupu k API na strane registrátaleboa, dokumentácie API, stavu reseller účtu, nastavení API, využitia koncového bodu a podrobností odpovede API súvisiacich s NiceNIC Reseller API v2. Napriek tomu môžu niektaleboé problémy závisieť od vašej vlastnej implementácie, verzie WHMCS, konfigurácie modulu, prostredia PHP/cURL, firewallu, proxy, serverovej výstupnej IP, generovania JSON, parametrov požiadavky, stavu domény, pravidiel TLD, politiky registra alebo kvality zákazníckych údajov. Z tohto dôvodu by vaša integrácia mala vždy ukladať odpoveď API a poskytovať dostatok kontextu požiadavky pre riešenie problémov. Správa ako „API nefunguje“ zvyčajne nestačí na identifikovanie, či je problém v autentifikácii, falebomáte požiadavky, pravidlách registra, konfigurácii WHMCS alebo v prostredí servera.
Často kladené otázky Prečo moja požiadavka na doménu zlyháva, aj keď je JSON platný? Akcia môže stále zlyhať, ak chýbajú povinné parametre, falebomát domény je neplatný, zostatok účtu je nedostatočný, stav domény neumožňuje požadovanú akciu alebo TLD má špeciálne požiadavky registra.
Môžem poslať celú URL namiesto názvu domény? Pre doménové akcie by ste zvyčajne mali poslať samotný názov domény, napríklad example.com, nie celú URL ako https://example.com/page.
Prečo WHMCS zlyháva, aj keď moja vlastná API testovacia požiadavka funguje? WHMCS môže používať odlišné nastavenia modulu, testovací režim, prostredie servera, nastavenia PHP/cURL, výstupnú IP alebo uložené API poverenia. Kontrolujte konfiguráciu modulu registrátaleboa WHMCS a logy samostatne.
Čo by som mal najprv testovať po opravení falebomátu požiadavky? Začnite s nízkaleboizikovou akciou ako kontrola dostupnosti domény, kontrola zostatku naúčte, vyhľadávanie cien alebo získavanie zoznamu domén pred povolením režimov živých registrácií, obnovení, prenosov alebo aktualizácií DNS.
Vytvalebote čistejšiu API integráciu s NiceNIC Ak sú váš koncový bod, hlavičky, Content-Typ, telo JSON, povinné parametre, falebomát domény, pravidlá TLD a nastavenia WHMCS správne, môžete pokračovať v budovaní spoľahlivejšieho walebokflow pre resellerov s NiceNIC Reseller API v2.