Visão geral da API
Documentação da NiceNIC Domain API v2 e início rápido
A NiceNIC Domain API v2 está disponível tanto para Contas de Mercado quanto para Contas de Revendedor. Use esta visão geral para configurar o acesso, confirmar sua primeira solicitação, entender o modelo de resposta da API e ir diretamente para a seção correta na navegação à esquerda.
O acesso à API e os preços de revendedor são separados.
Conta Market: acesso à API com preços da Conta Market.
Conta de Revendedor: acesso à API com os preços atribuídos ao nível atual de revendedor.
Compare os níveis e preços de revendedor →
Conta Market: acesso à API com preços da Conta Market.
Conta de Revendedor: acesso à API com os preços atribuídos ao nível atual de revendedor.
Compare os níveis e preços de revendedor →
Endpoint base
https://api.nicenic.net/v2/
Cabeçalhos obrigatórios
Host: api.nicenic.net Authorization: username:api_secret Content-Type: application/json
Resposta de sucesso padrão
{ "code": 0, "msg": "success", "data": {} }
Ambiente de teste da API
Teste sua integração antes de entrar em produção
Use o ambiente de testes de API NiceNIC para testar sua integração com a API de domínios antes de mover para produção. Valide a autenticação, as solicitações de API, o tratamento de respostas e o fluxo de trabalho do seu aplicativo em um ambiente de teste dedicado.
Ideal para revendedores, provedores de hospedagem, desenvolvedores e plataformas que preparam uma integração de API.
Início Rápido
Faça sua primeira chamada de API em 4 etapas
Comece com uma solicitação somente leitura antes de ativar registros, renovações ou transferências ao vivo. Isso permite validar a autenticação, a formatação de solicitações e o tratamento de respostas sem fazer um pedido pago.
1
Ativar acesso à API
Abra as configurações de API, crie ou recupere seu segredo de API e configure endereços IP de servidores autorizados quando aplicável.
2
Confirmar Autenticação
Use HTTPS com o cabeçalho de Autorização no formato username:api_secret.
3
Faça um Teste Seguro
Comece pela disponibilidade de domínio, preços, saldo da conta ou listagem de domínios.
4
Tratar a Resposta
Leia e armazene o code e a msg retornados antes de habilitar ações de produção pagas.
Primeira solicitação recomendada: disponibilidade de domínio
O endpoint de disponibilidade aceita vários domínios em uma única solicitação, separando os nomes de domínio por vírgulas.
curl "https://api.nicenic.net/v2/?category=domain&action=check&domains=example.com,example.net" \ -H "Authorization: username:api_secret" \ -H "Content-Type: application/json"
Mapa da API
Escolha o fluxo de trabalho que você precisa
A visão geral abaixo espelha a navegação à esquerda. Use-a para identificar o fluxo de trabalho correto e, em seguida, abra a página do endpoint dedicada para ver parâmetros, exemplos de solicitação e exemplos de resposta.
| Seção | Use para | Funções documentadas |
|---|---|---|
| Primeiros passos | Conecte-se com segurança e entenda o tratamento de respostas. | Visão geral da API, Sandbox da API, Autenticação, Códigos de resposta. |
| Gerenciamento de domínios | Automatize o ciclo de vida essencial dos domínios. | Disponibilidade, Listar domínios, Detalhes do domínio, Registro, Renovação, Transferência de entrada, Servidores de nomes, Contatos, Preços. |
| Abuso e conformidade | Monitore domínios que exigem atenção de conformidade. | Liste domínios com relatórios de abuso e obtenha status de abuso legível por máquina, ciclo de vida de retenção, informações de reclamação e ação recomendada. |
| Registros DNS | Gerencie registros DNS hospedados programaticamente. | Liste, crie, atualize e exclua registros DNS. |
| Nameservers Filhos | Gerencie registros de host / glue para nameservers sob seu próprio domínio. | Crie, liste, atualize e exclua nameservers filhos. |
| Conta e Cobrança | Conecte a automação a verificações no nível da conta. | Saldo da conta e informações de conta relacionadas a transações. |
| WHMCS API | Integre a NiceNIC a um fluxo de trabalho de cobrança WHMCS existente. | Disponibilidade, registro, renovação, transferência, detalhes de domínio, nameservers, contatos e funções adicionais do módulo de registro. |
| Perguntas frequentes sobre API | Resolva dúvidas comuns sobre acesso, segurança, testes e fluxos de trabalho. | Elegibilidade, credenciais, tratamento de solicitações, operações suportadas e orientações de integração. |
Fluxo de trabalho recomendado
Sequência recomendada para primeira integração
Uma integração de produção confiável deve validar as condições de acesso e compra antes de começar a enviar pedidos reais de clientes.
1. Autenticação
API Secret + IP autorizado
API Secret + IP autorizado
→
2. Disponibilidade
Teste de conectividade somente leitura
Teste de conectividade somente leitura
→
3. Preços
Consulte o custo atual do nível da conta
Consulte o custo atual do nível da conta
→
4. Saldo
Confirme os fundos para ações pagas
Confirme os fundos para ações pagas
→
5. Tratamento de respostas
Processe o código + msg
Processe o código + msg
→
6. Operações ao Vivo
Registrar / Renovar / Transferir
Registrar / Renovar / Transferir
Não presuma que uma solicitação de API está completa simplesmente porque foi aceita. Algumas operações podem retornar um status pendente e ainda exigir processamento do registro antes que o estado final do domínio seja confirmado.
Comportamento em Produção
Entenda as Respostas de Sucesso, Pendência e Erro
code: 0 — Resposta de Sucesso Os exemplos de endpoint atuais usam o código 0 para respostas concluídas com sucesso.
code: 201 — Pedido Pendente A documentação de registro e transferência pode retornar o código 201 quando um pedido foi enviado, mas o processamento final ainda está pendente.
code: 400 — Erro de Solicitação Os exemplos de endpoint usam o código 400 para erros de parâmetros de solicitação.
Comportamento de Registro Pendente
Para registro de domínio, a documentação atual afirma que uma resposta 201 significa que o pedido foi enviado com sucesso e a taxa foi deduzida, mas a ativação final ainda está sujeita à confirmação do registro. Se o domínio não puder ser ativado, a taxa de registro é devolvida ao saldo da conta NiceNIC dentro de 24 horas.
Comportamento de Transferência Pendente
O endpoint de transferência também documenta 201 como um pedido pendente. Portanto, seu aplicativo deve tratar uma transferência pendente como aceita para processamento, não como prova de que a transferência já foi concluída.
Preços
Consulte os preços antes de operações pagas
O endpoint de preços da NiceNIC pode obter os preços de registro, renovação e transferência de um domínio. Os valores de type documentados são register, renew, transfer e all. O período documentado é de 1 a 10 anos, com possíveis exceções específicas de TLD.
As respostas de preços de registro também podem retornar um sinalizador is_premium. Use o endpoint de preços antes de enviar uma solicitação paga quando o seu aplicativo precisar saber o custo atual no nível da conta.
O acesso gratuito à API não altera seu nível de preços. Contas de Mercado usam os preços de Conta de Mercado; contas de revendedor usam os preços atribuídos ao seu nível atual de revendedor.
Operações de domínios e DNS
Entenda a diferença entre servidores de nomes, registros DNS e servidores de nomes filhos
| Operação | Use quando | Capacidade documentada |
|---|---|---|
| Atualizar servidores de nomes | Você deseja delegar um domínio para diferentes nameservers autoritativos. | O endpoint de nameservers do domínio suporta um nameserver primário, um secundário e adicionais, com a página atual documentando um limite de até seis. |
| Registros DNS | Você está usando a hospedagem DNS da NiceNIC e precisa gerenciar os registros de zona. | APIs separadas são documentadas para listar, criar, atualizar e excluir registros DNS. |
| Nameservers Filhos | Você precisa de registros de host / glue, como ns1.example.com. |
Crie, liste, atualize e exclua nameservers filhos. O endpoint de criação requer que o hostname do nameserver corresponda ao domínio e aceita um endereço IP. |
Portfólio e Conformidade
Automatize o Monitoramento do Portfólio, Não Apenas Pedidos de Domínio
A API de Domínios v2 também inclui operações de leitura úteis após o registro. O endpoint List Domains oferece suporte a paginação, classificação, filtragem por status e filtragem por retenção, enquanto Get Domain Details retorna datas de registro, datas de expiração, servidores de nomes e informações de contato do titular do registro.
Monitoramento de Abuso e Conformidade
A API de Abuso e Conformidade da NiceNIC pode listar domínios com relatórios de abuso e retornar um resumo detalhado legível por máquina para um domínio específico. O endpoint de abuso detalhado documenta seis frases de status em nível de domínio: Normal, Em Revisão, ClientHold Pendente, ClientHold, Fechado e ServerHold.
A resposta pode incluir impacto atual, próxima ação recomendada, estado e cronograma de bloqueio, número de reclamações, datas das reclamações, categorias, classificação de abuso DNS, status de evidências e URLs relatadas quando aplicável. Isso permite que plataformas e revendedores exibam o status de conformidade em seus próprios sistemas operacionais, em vez de depender apenas de revisão manual.
API direta ou WHMCS
Escolha o modelo de integração que se adapta ao seu sistema
| Opção | Ideal para | O que a documentação atual fornece |
|---|---|---|
| Domain API v2 | Websites personalizados, plataformas SaaS, sistemas internos, fluxos de cobrança ou provisionamento personalizados. | Integração direta por HTTPS + JSON em operações de domínio, DNS, nameservers filho, conta e conformidade. |
| Módulo WHMCS | Empresas de hospedagem e revendedores que já utilizam WHMCS. | Disponibilidade, registro, renovação, transferência, detalhes de domínio, nameservers, contatos, bloqueio/desbloqueio, recuperação de EPP, registro de erros e Modo de Teste opcional. |
A documentação atual do WHMCS lista como requisitos: WHMCS 7.0 ou superior, PHP 7.0 ou superior com cURL, credenciais válidas da API NiceNIC e suporte a SSL/TLS.
Solução de problemas
Quando uma solicitação de API falha
Comece pela resposta retornada e pelo estado da configuração, em vez de repetir a mesma ação paga várias vezes.
Erro de autenticação ou acesso
- Confirme o nome de usuário da NiceNIC e o API Secret.
- Confirme se o cabeçalho Authorization está presente e formatado corretamente.
- Confirme se o API Secret não foi redefinido ou rotacionado.
- Se as restrições de IP estiverem habilitadas, confirme se a solicitação está vindo do IP de servidor de saída autorizado.
Erro de Parâmetro de Solicitação
- Compare a solicitação com os parâmetros documentados do endpoint específico.
- Confirme os valores, formatos e nomes de ação obrigatórios.
- Verifique os períodos de registro específicos do TLD ou os requisitos de contato, quando aplicável.
Operação paga não é concluída imediatamente
- Leia o
codeemsgretornados. - Não trate uma resposta pendente
201como conclusão final. - Confirme o saldo da conta e os preços atuais antes de tentar novamente uma ação paga.
Precisa de suporte da NiceNIC
- Registre o carimbo de data/hora da solicitação e a ação da API.
- Inclua o nome de domínio ou objeto envolvido, quando aplicável.
- Inclua o código e a mensagem retornados.
- Compartilhe apenas parâmetros não sensíveis; nunca publique o segredo completo da API em um chamado.
Próximo Passo
Comece com uma Solicitação de Teste Segura
Ative o acesso à API, confirme a autenticação, execute uma solicitação de disponibilidade ou preço e verifique o tratamento da resposta antes de ativar operações pagas voltadas ao cliente.
Última verificação: 26 de agosto de 2026
