Perguntas frequentes sobre a NiceNIC Domain API v2

A NiceNIC Domain API v2 é uma API baseada em HTTPS e JSON para automatizar o gerenciamento de domínios por meio da sua conta NiceNIC.

Ela oferece suporte aos fluxos de trabalho essenciais, incluindo verificações de disponibilidade de domínio, registro, renovação, transferência, consultas de portfólio, atualizações de servidores de nomes e contatos, preços, registros DNS, servidores de nomes filhos, informações da conta e operações relacionadas à conformidade.

Use a API quando quiser conectar os serviços de domínio da NiceNIC diretamente a um site, plataforma de hospedagem, sistema de cobrança, ferramenta interna ou outro aplicativo.

Qualquer conta NiceNIC ativa pode usar a Domain API v2. O acesso à API está disponível tanto para Contas de Mercado quanto para Contas de Revendedor.

Você não precisa se tornar um revendedor apenas para obter acesso à API. O tipo de conta ainda importa para os preços: operações pagas da API usam os preços atribuídos à conta NiceNIC que envia a solicitação.

Abrir Configurações da API →

Sim. O acesso à API é gratuito. Não há taxa separada para ativar o acesso à API ou enviar solicitações de API suportadas.

Operações pagas, como registro, renovação e transferência de domínios, são cobradas de acordo com o preço da sua conta e as regras de domínio aplicáveis.

Não. O acesso à API e os preços de revendedor são separados.

Você pode usar a API de Domínios v2 com uma conta NiceNIC Market comum. Atualize para uma conta de revendedor somente quando os preços de revendedor ou outros benefícios de revenda forem úteis para o volume do seu negócio.

Comparar planos de revendedor →

A API de Domínios v2 usa a estrutura atual da API NiceNIC com solicitações HTTPS, respostas em JSON, autenticação baseada em cabeçalho e documentação organizada em torno de fluxos de trabalho individuais de domínios e contas.

Se você mantém uma integração criada com uma API NiceNIC mais antiga, revise os parâmetros da API v2 e o tratamento de respostas antes de migrar o tráfego de produção, em vez de assumir que as duas versões são intercambiáveis.

Entre na sua conta NiceNIC e abra Configurações de API. As solicitações da API v2 usam seu nome de usuário NiceNIC e o Segredo da API para autenticação.

Abrir Configurações da API →

Sim. A NiceNIC fornece um API Sandbox para que os desenvolvedores testem integrações antes de conectá-las à API de produção.

Use o Sandbox para validar autenticação, formatação de solicitações, análise de respostas, tratamento de erros e o fluxo de trabalho do seu aplicativo antes de habilitar operações de domínio ao vivo para clientes.

Abrir API Sandbox →

O API Sandbox é destinado ao desenvolvimento e testes de integração. A API de Produção é usada para operações de domínio ao vivo e solicitações pagas na sua conta NiceNIC.

Recomendamos validar autenticação, tratamento de solicitações, processamento de respostas e lógica de erros no Sandbox antes de habilitar operações de produção voltadas ao cliente.

Envie solicitações à API por HTTPS e inclua seu nome de usuário NiceNIC e o API Secret no cabeçalho Authorization.

Host: api.nicenic.net
Authorization: username:api_secret
Content-Type: application/json

Se restrições de IP estiverem habilitadas para sua conta, as solicitações também devem originar-se de um IP de servidor autorizado.

Leia Autenticação da API →

O endpoint base da API de Produção é:

https://api.nicenic.net/v2/

As ações da API são selecionadas usando os parâmetros documentados para cada endpoint, como category e action. Sempre siga a documentação dedicada do endpoint para os parâmetros obrigatórios e opcionais de uma operação específica.

As respostas da API v2 usam JSON, e os parâmetros de solicitação usam UTF-8.

{
  "code": 0,
  "msg": "success",
  "data": {}
}

Seu aplicativo deve inspecionar os valores code e msg retornados, em vez de presumir que toda resposta HTTP representa uma operação de domínio concluída.

Por meio das APIs atualmente documentadas, você pode automatizar fluxos de trabalho, incluindo verificações de disponibilidade de domínio, registro, renovação e transferência, listagem de portfólio e detalhes de domínio, atualizações de nameservers e contatos de domínio, preços de domínio, registros DNS, nameservers filhos, informações da conta e monitoramento de Abuso e Conformidade.

Fluxos de trabalho adicionais são documentados individualmente na navegação da API.

Comece com operações de leitura de baixo risco, como disponibilidade de domínio, preços de domínio, saldo da conta e listagem de domínios.

Em seguida, confirme a autenticação, o parsing de respostas, o tratamento de erros e o gerenciamento de pedidos pendentes antes de ativar registros, renovações ou transferências ao vivo.

Sim. O endpoint Check Domain Availability suporta vários nomes de domínio separados por vírgulas.

example.com,example.net,example.org

Não presuma que toda operação da API suporta o mesmo formato de entrada com vários domínios. Registro, renovação e transferência devem seguir a documentação individual de cada endpoint.

Use o endpoint Obter Preços de Domínio. Os tipos de preços documentados incluem register, renew, transfer e all.

As respostas de registro também podem incluir um valor is_premium que indica se o registro consultado é premium.

Como os pedidos de API usam preços no nível da conta, consulte os preços atuais antes de enviar pedidos pagos de clientes, em vez de confiar indefinidamente em preços em cache.

Não. Embora a documentação da API suporte períodos de até 1–10 anos para extensões aplicáveis, TLDs individuais podem ter regras de registro diferentes.

Os períodos de registro, períodos de renovação, elegibilidade para transferência, requisitos de contato e requisitos de verificação podem variar de acordo com a extensão. Seu aplicativo deve seguir as regras atuais para o TLD relevante.

Essas são operações separadas e não devem ser tratadas como intercambiáveis.

Sempre use o código e a mensagem retornados ao determinar o estado de uma solicitação de API.

Ver códigos de resposta da API →

Uma resposta 201 significa que a operação foi aceita para processamento, mas não atingiu necessariamente seu estado final.

Para registro de domínio, uma resposta 201 indica que o pedido foi enviado e está aguardando o processamento final do registro.

Não informe a um cliente final que o domínio está ativo até que o seu sistema tenha confirmado o resultado final. Siga a documentação do endpoint de registro para as regras mais recentes de pedidos pendentes e tratamento de reembolsos.

Uma transferência pendente significa que a solicitação de transferência foi aceita para processamento, não que o domínio já concluiu sua transferência para a NiceNIC.

A conclusão da transferência pode depender do processamento do registro e do registrador, bem como do status atual de transferência do domínio. Mantenha a transferência em estado pendente até que a conclusão seja confirmada.

Sim. A API List Domains oferece suporte à recuperação de portfólio com opções de paginação, classificação e filtragem.

Use Get Domain Details quando precisar de informações detalhadas para um domínio individual, como informações de registro, informações de expiração, servidores de nomes e dados de contato do domínio.

A NiceNIC Domain API v2 inclui operações de Abuso e Conformidade projetadas para plataformas e revendedores que gerenciam portfólios de domínios de clientes.

Você pode identificar domínios associados a relatórios de abuso e recuperar informações de conformidade legíveis por máquina para domínios individuais. Dependendo do caso, a resposta pode incluir status do domínio, impacto atual, ação recomendada, informações de retenção, informações de reclamação e URLs relatados.

Isso torna possível exibir o status de conformidade diretamente dentro do seu próprio portal do cliente ou sistema operacional.

Sim. A NiceNIC fornece uma integração de registrador WHMCS para empresas que já usam WHMCS para cobrança e provisionamento.

Use a API de Domínios v2 direta ao criar seu próprio aplicativo ou fluxo de trabalho. Use a integração WHMCS quando desejar integrar operações de domínio a um ambiente WHMCS existente.

Ver Integração WHMCS →

Qualquer linguagem ou runtime de servidor capaz de enviar solicitações HTTPS e analisar JSON pode se integrar à API de domínios v2.

As escolhas comuns incluem PHP, Python, Node.js e Java. Mantenha as credenciais da API no lado do servidor e nunca exponha seu segredo de API em JavaScript no lado do navegador ou em código cliente para download.

A limitação de taxa pode ser aplicada para proteger a estabilidade da API e a segurança da plataforma.

Se sua integração em produção deve gerar um volume alto e constante de solicitações, entre em contato com a NiceNIC antes do lançamento para que o padrão de uso esperado possa ser analisado.

Inclua o carimbo de data/hora da solicitação, a categoria e a ação da API, o nome de domínio quando aplicável, os parâmetros de solicitação não sensíveis, o código e a mensagem de resposta retornados e se a solicitação veio do ambiente de testes ou da produção.

Enviar um ticket →

Use a navegação da API na documentação. Cada operação tem sua própria página com parâmetros suportados, exemplos de solicitação, exemplos de resposta e comportamento específico da operação.

As perguntas frequentes explicam o comportamento geral da API; a documentação de cada endpoint deve ser tratada como a fonte da verdade para o formato exato da solicitação.

Abrir documentação da API →