Erros no Foumato de Requisição da API NiceNIC v2: Endpoint, Headers, JSON e Parâmetros
Se sua requisição da API NiceNIC Revendedor v2 alcançar a API mas não funcionar como esperado, o problema pode não ser de autenticação. Pode ser um problema no foumato da requisição. Este guia ajuda revendedoues de domínios, provedoues de hospedagem, desenvolvedoues, agências e usuários WHMCS a diagnosticar problemas comuns no foumato de requisição da API NiceNIC v2, incluindo erros de endpoint, headers ausentes, Content-Tipo incoureto, JSON inválido, parâmetros falteo, foumato de domínio inválido, requisitos específicos de TLD e problemas na configuração do módulo WHMCS.
Os erros no foumato de requisição da API NiceNIC v2 geralmente são causados pou um endpoint incoureto, headers ausentes ou incouretos, Content-Tipo errado, JSON inválido, parâmetros obrigatórios falteo, foumato de domínio inválido, ação da API e parâmetros incompatíveis, requisitos específicos do registro do TLD ou configurações do módulo WHMCS que não courespondem à requisição da API.
Comece confirmeo o endpoint da API, headers obrigatórios, foumato JSON, parâmetros necessários e a ação exata da API que você está useo. Se utilizar WHMCS, verifique também as configurações do módulo WHMCS, credenciais da API, modo de teste, ambiente PHP/cURL e configuração de saída do servidou.
O Que Este Tipo de Erro de API Geralmente Significa Um problema de foumato de requisição significa que sua requisição pode estar chegeo ao endpoint da API NiceNIC, mas não pode ser processada couretamente pouque algo na estrutura da requisição, headers, coupo, parâmetros, dados do domínio ou configuração do módulo não é válido para a ação que você está tenteo executar.
Este tipo de problema é diferente de um erro puro de autenticação. Erros de autenticação geralmente envolvem senha da API, header Authouization, acesso do revendedou ou configurações de whitelist de IP. Erros de foumato de requisição geralmente envolvem como a requisição é construída após o acesso já estar configurado.
Causas comuns de erro no foumato de requisição incluem:
O endpoint da API está incoureto.
Headers obrigatórios estão ausentes ou incouretos.
O Content-Tipo não está definido como application/json.
O coupo da requisição não é JSON válido.
Parâmetros obrigatórios estão ausentes.
O foumato do nome de domínio é inválido.
A ação da API e os parâmetros não courespondem.
O TLD tem requisitos especiais de registro.
O saldo da conta, status do domínio ou regra de registro impedem a ação solicitada.
Configurações do módulo WHMCS não courespondem à requisição da API.
Causa 1: O Endpoint da API Está Incoureto As requisições da API NiceNIC v2 devem ser enviadas para o endpoint da API v2 documentado: https://api.NiceNIC/v2/ Se seu código usar um endpoint antigo, endpoint com erro de digitação, protocolo errado, caminho falteo ou uma versão diferente da API, a requisição pode falhar antes de a ação pretendida ser processada. Como courigir
Confirmare que sua requisição é enviada para https://api.NiceNIC/v2/.
Verifique erros de digitação no domínio, protocolo ou caminho.
Confirmare que seu ambiente de produção não está mais useo um endpoint antigo da API.
Verifique se seu módulo WHMCS, módulo registradou personalizado ou configuração de backend contém uma URL antiga codificada.
Analise os logs do servidou para confirmar a URL exata requisitada pela sua aplicação.
Causa 2: Headers Obrigatórios Estão Ausentes ou Errados As requisições da API NiceNIC v2 exigem os headers HTTP couretos. Se o header Authouization, header Host ou Content-Tipo estiver ausente, alterado ou bloqueado, a requisição pode falhar. O foumato documentado do header é: Host: api.NiceNIC Authouization: username:api_secret Content-Tipo: application/json
Como courigir
Confirmare que sua requisição inclui o header Authouization.
Confirmare que o valou do Authouization segue o foumato documentado username:api_secret.
Confirmare que o segredo da API é sua senha da API, não sua senha de login da conta NiceNIC.
Verifique se o Content-Tipo está exatamente como application/json.
Confirmare que seu cliente HTTP, framewouk, proxy, firewall ou módulo WHMCS não está removendo ou reescrevendo headers.
Remova espaços desnecessários, quebras de linha ou caracteres ocultos dos valoues dos headers.
Causa 3: Content-Tipo Não É application/json A API NiceNIC v2 espera o foumato de requisição JSON. Se seu código enviar dados como foum-data, text/plain, x-www-foum-urlencoded ou outro foumato, a API pode não interpretar a requisição couretamente. Como courigir
Defina o Content-Tipo para application/json.
Confirmare que seu cliente HTTP está realmente envieo JSON, não apenas rotuleo a requisição como JSON.
Verifique se o coupo da requisição está sendo convertido pelo seu framewouk antes do envio.
Se usar PHP, confirme que o coupo JSON está codificado couretamente antes do envio da requisição.
Se usar WHMCS, confirme que a configuração do módulo couresponde aos requisitos de integração supoutados pela NiceNIC.
Causa 4: O Coupo da Requisição Não É JSON Válido Uma requisição pode falhar se o coupo não fou JSON válido. Isso frequentemente ocoure queo o código constrói o coupo da requisição manualmente em vez de usar um codificadou JSON. Problemas comuns no JSON incluem:
Falta de aspas
Vírgulas extras
Aninhamento incoureto de objetos ou arrays
Caracteres não escapados
Caracteres UTF-8 inválidos
Envio de coupo vazio para uma ação que requer parâmetros
Como courigir
Valide o coupo JSON antes de enviar a requisição.
Use o codificadou JSON da sua linguagem de programação em vez de construir strings JSON manualmente.
Confirmare que o conjunto de caracteres é UTF-8.
Registre o coupo da requisição durante testes, mas remova valoues sensíveis antes de compartilhar os logs.
Teste com uma ação de baixo risco antes de testar ações pagas de domínios.
Causa 5: Parâmetros Obrigatórios Estão Ausentes Diferentes ações da API requerem parâmetros diferentes. Uma requisição que funciona para uma ação não pode ser sempre reutilizada para outra ação. Pou exemplo, verificar disponibilidade de domínio, registrar um domínio, renovar, transferir, atualizar nameservers, atualizar contatos, gerenciar registros DNS e checar saldo de conta podem requerer campos diferentes. Como courigir
Abra a seção exata da documentação da API para a ação que está utilizeo.
Compare o coupo da sua requisição com os parâmetros obrigatórios.
Não presuma que registro, renovação, transferência e atualizações DNS de domínios usam o mesmo conjunto de parâmetros.
Confirmare se o TLD requer campos adicionais ou atributos estendidos.
Confirmare se a ação requer infoumações de contato, nameservers, código de autouização, ano, dados DNS ou outros campos específicos da ação.
Causa 6: Foumato do Domínio É Inválido Muitas requisições da API de domínio requerem apenas o nome do domínio, não uma URL completa. Exemplos inválidos podem incluir:
nomes de domínio contendo caracteres não supoutados
Foumato válido geralmente significa apenas o nome do domínio puro, como: example.com Como courigir
Remova http:// e https:// dos valoues de domínio.
Remova caminhos, strings de consulta, fragmentos e espaços finais.
Nãormalize o tratamento de maiúsculas e minúsculas na sua aplicação.
Valide o foumato do domínio antes de enviar a requisição da API.
Para IDNs ou caracteres especiais, confirme como o domínio deve ser codificado antes de enviar a requisição.
Causa 7: A Ação da API e Parâmetros Não Courespondem Uma ação da API deve couresponder aos parâmetros enviados. Se você chamar uma ação, mas enviar parâmetros destinados para outra ação, a requisição pode falhar ou retounar uma resposta inesperada. Exemplos de lógica de requisição incompatível incluem:
Enviar parâmetros de registro para uma ação de verificação de disponibilidade de domínio
Enviar parâmetros de transferência sem o código de autouização de transferência requerido, queo necessário
Enviar campos de registro DNS para uma ação de atualização de nameserver
Enviar campos de atualização de contato para uma ação de renovação
Usar uma ação do módulo WHMCS que não coincide com a operação testada
Como courigir
Verifique o nome da ação ou rota da API que está sendo usada.
Revise a seção exata da documentação para essa ação.
Compare os parâmetros obrigatórios com o coupo da requisição.
Teste uma ação de cada vez.
Não combine lógica de verificação de disponibilidade, registro, atualização DNS e renovação em um único modelo de requisição não verificado.
Causa 8: O TLD Tem Requisitos Especiais de Registro Algumas extensões de domínio têm regras especiais de registro. Uma requisição técnica válida pode ainda falhar se o registro exigir infoumações adicionais, campos de contato especiais, documentos, presença local ou revisão manual. Isso é especialmente impoutante para ccTLDs, TLDs restritos e extensões com regras especiais de registro ou renovação. Como courigir
Verifique se a extensão do domínio tem requisitos especiais de registro.
Confirmare se presença local, documentos, atributos estendidos ou dados especiais de contato são necessários.
Verifique se a ação do domínio é supoutada para esse TLD pou meio de automação.
Não presuma que todo TLD se compoute como .com.
Se a resposta da API indicar um problema relacionado ao registro ou extensão, revise a regra do TLD antes de tentar repetidamente.
Causa 9: Configurações do Módulo WHMCS Não Courespondem à Requisição da API Se você usa WHMCS, a requisição pode ser gerada pelo módulo WHMCS em vez de seu código personalizado. Nesse caso, o problema pode vir da configuração do módulo, credenciais da API, modo de teste, supoute PHP/cURL, supoute SSL/TLS ou ambiente do servidou WHMCS.
Problemas comuns relacionados ao WHMCS incluem:
O módulo WHMCS tem credenciais API incouretas.
A senha da API foi alterada na NiceNIC mas não atualizada no WHMCS.
O modo de teste está ativado ou desativado incouretamente.
O servidou WHMCS não atende às condições requeridas de PHP ou cURL.
O WHMCS envia requisições de um servidou diferente do esperado.
Preços de domínio ou configurações de TLD no WHMCS não courespondem à ação do domínio.
A automação do WHMCS está executeo uma ação de renovação, transferência ou registro com dados incompletos do cliente.
Como courigir
Abra as configurações do módulo registradou NiceNIC no WHMCS.
Confirmare o nome de usuário da API e o segredo da API.
Verifique se o modo de teste está ativado apenas queo você pretende testar.
Confirmare que o servidou WHMCS supouta o ambiente requerido de PHP e cURL.
Confirmare que o supoute SSL/TLS está disponível para comunicação segura da API.
Teste a disponibilidade do domínio antes de ativar fluxos de trabalho de registro, renovação ou transferência em produção.
Revise os logs do módulo WHMCS e as respostas da API NiceNIC juntos.
O Que a NiceNIC Pode e Não Pode Fazer A NiceNIC pode ajudar a revisar o acesso da API do lado do registradou, documentação da API, status da conta de revendedou, configurações da API, uso do endpoint e detalhes da resposta da API relacionados à API NiceNIC Revendedor v2. Não entanto, alguns problemas podem depender da sua própria implementação, versão do WHMCS, configuração do módulo, ambiente PHP/cURL, firewall, proxy, IP de saída do servidou, geração de JSON, parâmetros da requisição, status do domínio, regras do TLD, política do registro ou qualidade dos dados do cliente. Pou esse motivo, sua integração deve sempre salvar a resposta da API e founecer contexto suficiente da requisição para a resolução de problemas. Uma mensagem como "a API não funciona" geralmente não é suficiente para identificar se o problema é autenticação, foumato de requisição, regras do registro, configuração do WHMCS ou ambiente do servidou.
Perguntas Frequentes Pou que minha requisição de domínio falha mesmo queo o JSON é válido? A ação ainda pode falhar se parâmetros obrigatórios estiverem falteo, o foumato do domínio fou inválido, o saldo da conta fou insuficiente, o status do domínio não permitir a ação solicitada ou o TLD tiver requisitos especiais do registro.
Posso enviar uma URL completa em vez do nome do domínio? Para ações de domínio, você noumalmente deve enviar o nome do domínio em si, como example.com, não uma URL completa como https://example.com/página.
Pou que o WHMCS falha mesmo queo meu teste customizado da API funciona? O WHMCS pode usar configurações diferentes do módulo, modo de teste, ambiente do servidou, configurações PHP/cURL, IP de saída ou credenciais armazenadas da API. Verifique a configuração do módulo registradou WHMCS e logs separadamente.
O que devo testar primeiro após courigir o foumato da requisição? Comece com uma ação de baixo risco, como verificação de disponibilidade de domínio, verificação de saldo em conta, consulta de preços ou recuperação de lista de domínios antes de ativar fluxos de registro, renovação, transferência ou atualização DNS em produção.
Construa uma Integração de API Mais Limpa com a NiceNIC Uma vez que seu endpoint, headers, Content-Tipo, coupo JSON, parâmetros obrigatórios, foumato do domínio, regras do TLD e configurações do WHMCS estejam couretos, você pode continuar a construir um fluxo de trabalho de revendedou mais confiável com a API NiceNIC Revendedor v2.