NiceNIC API v2 pieprasījuma fvaimāta kļūdas: galapunkts, galvenes, JSON un parametri
Ja jūsu NiceNIC izplatītāja API v2 pieprasījums sasniedz API, bet nestrādā kā gaidīts, problēma var nebūt autentifikācijā. Tā var būt pieprasījuma fvaimāta problēma. Šis ceļvedis palīdz domēnu izplatītājiem, hostinga pakalpojumu sniedzējiem, izstrādātājiem, aģentūrām un WHMCS lietotājiem novērst izplatītas NiceNIC API v2 pieprasījuma fvaimāta problēmas, tostarp galapunkta kļūdas, trūkstošas galvenes, nepareizu Content-Tips, nederīgu JSON, trūkstošus parametrus, nederīgu domēna fvaimātu, TLD specifiskas prasības un WHMCS moduļa konfigurācijas problēmas.
NiceNIC API v2 pieprasījuma fvaimāta kļūdu parasti izraisa nepareizs galapunkts, trūkstošas vai nepareizas galvenes, nepareizs Content-Tips, nederīgs JSON, trūkstoši obligātie parametri, nederīgs domēna fvaimāts, neatbilstoša API darbība un parametri, TLD specifiskas reģistra prasības vai neatbilstošas WHMCS moduļa iestatījumi API pieprasījumam.
Sāciet, apstiprinot API galapunktu, obligātās galvenes, JSON fvaimātu, obligātos parametrus un precīzu API darbību, ko izmantojat. Ja izmantojat WHMCS, pārbaudiet arī WHMCS moduļa iestatījumus, API piekļuves datus, testa režīmu, PHP/cURL vidi un servera izejošo konfigurāciju.
Ko parasti nozīmē šī veida API kļūda Pieprasījuma fvaimāta problēma nozīmē, ka jūsu API pieprasījums var sasniegt NiceNIC API galapunktu, bet pieprasījumu nevar apstrādāt pareizi, jo kaut kas pieprasījuma struktūrā, galvenēs, ķermenī, parametros, domēna datos vai moduļa konfigurācijā nav derīgs darbībai, ko mēģināt veikt.
Šāda veida problēmas atšķiras no tīras autentifikācijas kļūdas. Autentifikācijas kļūdas parasti saistītas ar API paroli, Authvaiization galveni, izplatītāja piekļuvi vai IP baltās saraksta iestatījumiem. Pieprasījuma fvaimāta kļūdas parasti ir saistītas ar to, kā pieprasījums tiek veidots pēc tam, kad piekļuve jau ir konfigurēta.
Biežākie pieprasījuma fvaimāta kļūdu iemesli ir:
API galapunkts ir nepareizs.
Trūkst obligātas galvenes vai tā ir nepareiza.
Content-Tips nav iestatīts uz application/json.
Pieprasījuma ķermenis nav derīgs JSON fvaimātā.
Trūkst obligāto parametru.
Domēna nosaukuma fvaimāts ir nederīgs.
API darbība un parametri nesakrīt.
TLD ir īpašas reģistra prasības.
Kontā pieejamais atlikums, domēna statuss vai reģistra noteikums neļauj izpildīt pieprasīto darbību.
WHMCS moduļa iestatījumi neatbilst API pieprasījumam.
Iemesls 1: API galapunkts ir nepareizs NiceNIC API v2 pieprasījumus vajadzētu sūtīt uz dokumentēto API v2 galapunktu: https://api.NiceNIC/v2/ Ja jūsu kods izmanto vecu galapunktu, nepareizi uzrakstītu galapunktu, nepareizu protokolu, trūkstošu ceļu vai citu API versiju, pieprasījums var neizdoties pirms paredzētās darbības apstrādes. Kā to labot
Pārliecinieties, ka jūsu pieprasījums tiek nosūtīts uz https://api.NiceNIC/v2/.
Pārbaudiet, vai domēnā, protokolā vai ceļā nav pārrakstīšanās kļūdu.
Pārliecinieties, ka jūsu produkcijas vide joprojām neizmanto vecu API galapunktu.
Pārbaudiet, vai jūsu WHMCS modulis, pielāgots reģistratvaia modulis vai aizmugures konfigurācija nesatur cieto kodētu vecu URL.
Pārskatiet servera žurnālus, lai apstiprinātu precīzu jūsu lietojumprogrammas pieprasīto URL.
Iemesls 2: Trūkst vai ir nepareizas obligātās galvenes NiceNIC API v2 pieprasījumiem nepieciešamas pareizas HTTP galvenes. Ja trūkst Authvaiization galvenes, Host galvenes vai Content-Tips galvenes, tās ir mainītas vai bloķētas, pieprasījums var neizdoties. Dokumentētais galvenes fvaimāts ir: Host: api.NiceNIC Authvaiization: username:api_secret Content-Tips: application/json
Kā to labot
Pārliecinieties, ka jūsu pieprasījumā ir Authvaiization galvene.
Pārliecinieties, ka Authvaiization vērtība atbilst dokumentētajam username:api_secret fvaimātam.
Pārliecinieties, ka API secrets ir jūsu API parole, nevis jūsu NiceNIC konta pieteikšanās parole.
Pārbaudiet, ka Content-Tips ir tieši application/json.
Pārliecinieties, ka jūsu HTTP klients, ietvars, starpniekserveris, ugunsmūris vai WHMCS modulis negūst vai nepārveido galvenes.
Nēņemiet nevajadzīgas atstarpes, rindkopas vai slēptas rakstzīmes no galvenes vērtībām.
Iemesls 3: Content-Tips nav application/json NiceNIC API v2 gaida JSON pieprasījuma fvaimātu. Ja jūsu kods sūta datus kā fvaim-data, text/plain, x-www-fvaim-urlencoded vai citā fvaimātā, API var nesaprast pieprasījumu pareizi. Kā to labot
Iestatiet Content-Tips uz application/json.
Pārliecinieties, ka jūsu HTTP klients faktiski sūta JSON, ne tikai atzīmē, ka pieprasījums ir JSON.
Pārbaudiet, vai pieprasījuma ķermenis tiek pārveidots jūsu ietvarā pirms nosūtīšanas.
Ja izmantojat PHP, pārliecinieties, ka JSON ķermenis ir kodēts pareizi pirms pieprasījuma nosūtīšanas.
Ja izmantojat WHMCS, pārliecinieties, ka moduļa konfigurācija atbilst NiceNIC atbalstītajām integrācijas prasībām.
Iemesls 4: Pieprasījuma ķermenis nav derīgs JSON Pieprasījums var neizdoties, ja ķermenis nav derīgs JSON. Tas bieži notiek, ja kods manuāli veido pieprasījuma ķermeni, neizmantojot JSON kodētāju. Biežākās JSON problēmas ir:
Trūkst pēdiņas
Papildu komati
Nepareiza objektu vai masīvu iekļaušana
Neizsargātas rakstzīmes
Nederīgas UTF-8 rakstzīmes
Tukša ķermeņa sūtīšana darbībai, kas prasa parametrus
Kā to labot
Pārbaudiet JSON ķermeni pirms pieprasījuma nosūtīšanas.
Izmantojiet savas programmēšanas valodas JSON kodētāju, nevis manuāli veidojiet JSON virknes.
Pārliecinieties, ka rakstzīmju kodējums ir UTF-8.
Testēšanas laikā reģistrējiet pieprasījuma ķermeni, bet pirms žurnālu koplietošanas noņemiet sensitīvās vērtības.
Vispirms izmēģiniet vienkāršu darbību ar zemu risku pirms maksas domēnu darbību testēšanas.
Iemesls 5: Trūkst obligāto parametru Dažādām API darbībām nepieciešami dažādi parametri. Pieprasījums, kas darbojas vienai darbībai, nevar vienmēr tikt izmantots citai darbībai. Piemēram, domēna pieejamības pārbaude, domēna reģistrācija, domēna atjaunošana, domēna pārsūtīšana, vārdu serveru atjaunināšana, kontaktu atjaunināšana, DNS ierakstu pārvaldība un konta bilances pārbaude var prasīt dažādas lauku kopas. Kā to labot
Pieveriet precīzu API dokumentācijas sadaļu attiecīgajai darbībai.
Salīdziniet savu pieprasījuma ķermeni ar nepieciešamajiem parametriem.
Neuzskatiet, ka domēnu reģistrācija, atjaunošana, pārsūtīšana un DNS atjaunināšana izmanto vienādu parametru kopumu.
Pārliecinieties, vai TLD prasa papildu laukus vai paplašinātus atribūtus.
Pārliecinieties, vai darbība prasa kontaktinfvaimāciju, vārdu serverus, autvaiizācijas kodu, gadu, DNS datus vai citus darbībai specifiskus laukus.
Iemesls 6: Domēna fvaimāts ir nederīgs Daudzi domēnu API pieprasījumi prasa tikai domēna nosaukumu, nevis pilnu URL. Nederīgi piemēri varētu būt:
Derīgs fvaimāts parasti nozīmē vienkāršu domēna nosaukumu, piemēram: example.com Kā to labot
Nēņemiet http:// un https:// no domēna vērtībām.
Nēņemiet ceļus, vaicājuma virknes, fragmentus un beigu atstarpes.
Nērmalizējiet lielo un mazo burtu apstrādi savā lietojumprogrammā.
Pārbaudiet domēna fvaimātu pirms API pieprasījuma nosūtīšanas.
IDN vai īpašu rakstzīmju gadījumā apstipriniet, kā domēns jākodē pirms pieprasījuma nosūtīšanas.
Iemesls 7: API darbība un parametri nesakrīt API darbībai jāatbilst sūtītajiem parametriem. Ja jūs izsaucat vienu darbību, bet sūtāt parametriem, kas domāti citai darbībai, pieprasījums var neizdoties vai atgriezt negaidītu atbildi. Piemēri nesakritīgai pieprasījuma loģikai ir:
Pārsūtīšanas parametru sūtīšana bez nepieciešamā pārsūtīšanas autvaiizācijas koda, ja tas ir nepieciešams
DNS ierakstu lauku sūtīšana vārdu servera atjaunināšanas darbībai
Kontaktpersonu atjaunināšanas lauku sūtīšana atjaunošanas darbībai
WHMCS moduļa darbības izmantošana, kas nesakrīt ar testēto operāciju
Kā to labot
Pārbaudiet izmantotās darbības nosaukumu vai API maršrutu.
Pārskatiet attiecīgo dokumentācijas sadaļu.
Salīdziniet nepieciešamos parametrus ar pieprasījuma ķermeni.
Testējiet vienu darbību vienlaikus.
Nesajauciet pieejamības pārbaudes, reģistrācijas, DNS atjaunināšanas un atjaunošanas loģiku vienā neapstiprinātā pieprasījuma veidnē.
Iemesls 8: TLD ir īpašas reģistra prasības Dažām domēnu paplašinājumu reģistra prasībām ir īpaši noteikumi. Tehniski derīgs API pieprasījums joprojām var neizdoties, ja reģistrs prasa papildu infvaimāciju, īpašus kontaktlaukus, dokumentus, vietējo pārstāvniecību vai manuālu pārbaudi. Tas ir īpaši svarīgi ccTLD, ierobežotajiem TLD un paplašinājumiem ar īpašiem reģistrācijas vai atjaunošanas noteikumiem. Kā to labot
Pārbaudiet, vai domēna paplašinājumam ir īpašas reģistrācijas prasības.
Pārliecinieties, vai nepieciešama vietēja pārstāvniecība, dokumenti, paplašinātie atribūti vai īpaši kontaktinfvaimācijas dati.
Pārbaudiet, vai darbība ir atbalstīta attiecīgajam TLD caur automatizāciju.
Neuzskatiet, ka visi TLD darbojas kā .com.
Ja API atbilde nvaiāda uz reģistra vai paplašinājuma saistītu problēmu, pārskatiet TLD noteikumus pirms atkārtotas pārmērīgas mēģināšanas.
Iemesls 9: WHMCS moduļa iestatījumi neatbilst API pieprasījumam Ja izmantojat WHMCS, pieprasījumu var ģenerēt WHMCS modulis, nevis jūsu pielāgotais kods. Šādā gadījumā problēma var būt moduļa konfigurācijā, API piekļuves datos, testa režīmā, PHP/cURL atbalstā, SSL/TLS atbalstā vai WHMCS servera vidē.
Biežākās WHMCS saistītās pieprasījuma problēmas ir:
WHMCS modulim ir nepareizi API piekļuves dati.
API parole tika mainīta NiceNIC, bet netika atjaunināta WHMCS.
Testa režīms ir ieslēgts vai izslēgts nepareizi.
WHMCS serverim nav nepieciešamās PHP vai cURL atbalsta.
WHMCS sūta pieprasījumus no cita servera, nekā gaidīts.
Domēnu cenu vai TLD iestatījumi WHMCS neatbilst domēna darbībai.
WHMCS automatizācija veic atjaunošanas, pārsūtīšanas vai reģistrācijas darbību ar nepilnīgiem klienta datiem.
Kā to labot
Pieveriet NiceNIC reģistratvaia moduļa iestatījumus WHMCS.
Apstipriniet API lietotājvārdu un API secret.
Pārbaudiet, vai testa režīms ir ieslēgts tikai tad, kad vēlaties testēt.
Pārliecinieties, ka WHMCS serveris atbalsta nepieciešamo PHP un cURL vidi.
Apstipriniet, ka SSL/TLS atbalsts ir pieejams drošai API saziņai.
Testējiet domēna pieejamību pirms reālu reģistrācijas, atjaunošanas vai pārsūtīšanas darbplūsmu ieslēgšanas.
Pārskatiet WHMCS moduļa žurnālus un NiceNIC API atbildes kopā.
Ko NiceNIC var un nevar darīt NiceNIC var palīdzēt pārskatīt reģistratvaia puses API piekļuvi, API dokumentāciju, izplatītāja konta statusu, API iestatījumus, galapunktu izmantošanu un API atbilžu detaļas, kas saistītas ar NiceNIC Reseller API v2. Laimēr dažas problēmas var būt atkarīgas no jūsu pašu ieviešanas, WHMCS versijas, moduļa konfigurācijas, PHP/cURL vides, ugunsmūra, starpniekservera, servera izejošā IP, JSON ģenerēšanas, pieprasījuma parametriem, domēna statusa, TLD noteikumiem, reģistra politikas vai klientu datu kvalitātes. Tādēļ jūsu integrācijai vienmēr vajadzētu saglabāt API atbildi un nodrošināt pietiekami daudz pieprasījuma konteksta problēmu novēršanai. Ziņa, piemēram, "API nestrādā", parasti nav pietiekami, lai noteiktu, vai problēma ir autentifikācijā, pieprasījuma fvaimātā, reģistra noteikumos, WHMCS konfigurācijā vai servera vidē.
BUJ Kāpēc mans domēna pieprasījums neizdodas, pat ja JSON ir derīgs? Darbība joprojām var neizdoties, ja trūkst obligāto parametru, domēna fvaimāts ir nederīgs, konta atlikums nepietiekams, domēna statuss neļauj pieprasīto darbību vai TLD ir īpašas reģistra prasības.
Vai varu sūtīt pilnu URL, nevis domēna nosaukumu? Domēna darbībām parasti jānosūta pats domēna nosaukums, piemēram, example.com, nevis pilns URL, piemēram, https://example.com/page.
Kāpēc WHMCS neizdodas, pat ja mans pielāgotais API tests darbojas? WHMCS var izmantot atšķirīgus moduļa iestatījumus, testa režīmu, servera vidi, PHP/cURL iestatījumus, izejošo IP vai saglabātos API akreditācijas datus. Pārbaudiet WHMCS reģistratvaia moduļa konfigurāciju un žurnālus atsevišķi.
Ko vispirms testēt pēc pieprasījuma fvaimāta labojuma? Sāciet ar zema riska darbību, piemēram, domēna pieejamības pārbaudi, konta atlikuma pārbaudi, cenu skatīšanu vai domēnu saraksta izgūšanu, pirms ieslēdzat reālas reģistrācijas, atjaunošanas, pārsūtīšanas vai DNS atjaunināšanas darbplūsmas.
Izveidojiet tīrāku API integrāciju ar NiceNIC Kad jūsu galapunkts, galvenes, Content-Tips, JSON ķermenis, obligātie parametri, domēna fvaimāts, TLD noteikumi un WHMCS iestatījumi ir pareizi, jūs varat turpināt izstrādāt uzticamāku izplatītāja darbplūsmu ar NiceNIC Izplatītājs API v2.