API

Registro de transferência, verificações de disponibilidade, DNS e gerenciamento em seus próprios sistemas: pedidos em massa, varreduras de renovação, um painel de controle para seus clientes.

O API é a porta de entrada da máquina para as mesmas operações que a área cliente oferece. O que você pode fazer em uma página, você pode criar um script.

DESCANSO HTTPS com respostas JSON

Chaves API Criado e revogado na área do cliente

Cobertura total As mesmas operações da área de cliente

Auditável As chamadas são gravadas na conta

O que é isso

Os endpoints são agrupados por recurso – disponibilidade, domínios, nameservers, contatos, pedidos e faturas – e retornam JSON.
A autenticação utiliza uma chave API gerada na área do cliente, que pode ser revogada e substituída a qualquer momento.
Usos típicos: registro em massa, varreduras de expiração, sincronização do estado do domínio em seu próprio sistema, um painel de autoatendimento para clientes e fluxos de trabalho automatizados de certificados.
As mesmas regras de negócios se aplicam à web: um domínio não pode ser registrado do nada e uma transferência ainda precisa de um domínio desbloqueado e 60 dias.

Como funciona

01

Crie uma chave

Gere uma chave API na área do cliente, com escopo de acordo com o que ela precisa fazer.

02

Leia a documentação

Endpoints, parâmetros e formas de resposta.

03

Teste pequeno

Experimente endpoints somente leitura ou alguns domínios antes de automatizar.

04

Transmitir ao vivo com o registro

Adicione novas tentativas e registros antes de entrar em produção.

Disponibilidade e pesquisa

Verifique muitos nomes de uma vez para monitoramento e seleção.

Registro e renovação

Encomende, renove e leia o status do pedido.

DNS e servidores de nomes

Envie registros e alterações de servidores de nomes em massa.

Gerenciamento de contatos

Leia e atualize registrante, administrador, tecnologia e faturamento.

Pedidos e faturas

Leia pedidos, faturas e status de pagamento.

Rotação de chave

Revogar e substituir chaves; mantenha cada sistema em sua própria chave.

O que o API cobre

Por recurso

Recurso	O que você pode fazer
Domínios	Verifique a disponibilidade, registre-se, renove, leia o status e a validade
DNS	Ler e definir servidores de nomes, manter registros DNS
Privacidade e contatos	Defina o nível de privacidade, atualize todas as quatro funções de contato
Pedidos e faturamento	Leia pedidos, faturas e status de pagamento
Conta	Leia o saldo e os detalhes básicos da conta

O que você deve ter antes de se conectar

Quatro pequenas coisas que economizam a maior parte da depuração

Saldo ou método de pagamento funcional: o registro e a renovação são pedidos reais, e uma chamada falhará na etapa do pedido sem fundos.
Repetições e tratamento de erros: falhas na rede, limites de taxa e atrasos no upstream acontecem. Tente novamente leituras idempotentes; para encomendas, envie uma referência única e verifique antes de escrever novamente.
Logging: registre a referência, o domínio e o código de resposta. Quando algo é contestado posteriormente, esses registros são a única prova de que a ação aconteceu.
Privilégio mínimo: não use uma chave gravável para um trabalho somente leitura e forneça a cada sistema sua própria chave para que uma possa ser revogada sem quebrar as outras.

Uma chave API equivale a uma senha de conta. Mantenha-o em uma variável de ambiente do lado do servidor ou em um gerenciador de segredos, nunca em código front-end e nunca em um repositório.

Como as pessoas usam

Padrões comuns

Registrador em massa: envie uma seleção para registro e grave os resultados em seu próprio back-end.
Varreduras de renovação: extraia domínios que estão prestes a expirar todas as noites e crie seu próprio lembrete ou tarefas de renovação.
Painéis com etiqueta em branco: permita que seus clientes gerenciem domínios dentro do seu produto, sem fazer login aqui.
Reconciliação: extraia dados de domínio e pedido de acordo com uma programação e compare-os com seu próprio razão.

O que cada pedido inclui

Gerenciamento de chaves API

Crie, revogue e separe chaves por finalidade.

Documentação

Endpoints, parâmetros e respostas.

Terminais de domínio e DNS

Pesquise, registre, renove, DNS e servidores de nomes.

Pontos de extremidade de pedido e cobrança

Pedidos, faturas e status de pagamento.

Histórico de chamadas

Registrado na conta para solução de problemas.

Suporte

Abra um ticket se uma integração não funcionar bem.

Perguntas comuns

Existe algum custo extra para o API?

O API em si não é cobrado separadamente; você paga pelas operações comerciais que realiza. Existe um limite de taxa sensato para evitar o uso acidental ou abusivo.

Existe um SDK?

O API é o padrão HTTPS e JSON, portanto, qualquer cliente HTTP funciona. A documentação inclui exemplos de solicitações que podem ser adaptados diretamente.

E se uma chave vazar?

Revogue-o na área do cliente e gere um novo. A revogação entra em vigor imediatamente e as solicitações que usam a chave antiga são rejeitadas.

O teste custa alguma coisa?

Chamadas somente leitura não custam nada. O registro e a renovação são ordens reais e custam dinheiro, portanto, valide primeiro a lógica em um pequeno número de domínios.

O API pode gerenciar domínios registrados em outro lugar?

Não. Ela opera nos domínios desta conta, exatamente como a área do cliente.

Por favor, note

Mantenha as chaves API no servidor. Uma chave enviada no código do navegador ou em um pacote móvel é uma chave publicada.
Para solicitar endpoints, envie uma referência de solicitação exclusiva e verifique antes de gravar, para que uma nova tentativa de rede não seja registrada ou cobrada duas vezes.