Programadores → Início rápido

Início rápido

Em cinco minutos: uma chave de API, uma verificação de disponibilidade de domínio, um registo DNS e um webhook que avisa o seu código quando o registo muda. Todos os passos funcionam com curl ou com a CLI nameocean.

1. Obter uma chave

Abra Painel → Chaves de API e crie uma chave com account:read, domains:read, dns:write e webhooks:write. Ela é mostrada apenas uma vez. As chaves exigem login em dois passos na sua conta.

curl
$ export NAMEOCEAN_API_KEY=no_live_…
$ curl https://nameocean.net/api/v1/account -H "Authorization: Bearer $NAMEOCEAN_API_KEY"
{"email": "you@example.com", "credit": "42.00", "currency": "USD", "domains": 3, "dns_zones": 3}

Com a CLI pode dispensar a chave: nameocean login inicia sessão através do navegador. Instale-a com brew install nameocean/tap/nameocean ou curl -fsSL https://nameocean.net/install.sh | sh.

nameocean
$ nameocean login
$ nameocean account

2. Verificar um domínio

curl
$ curl "https://nameocean.net/api/v1/domains/check?name=kahvebot.com" \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY"
{"name": "kahvebot.com", "available": true, "years": 1, "premium": false,
 "register_price": "10.99", "renew_price": "10.99", "currency": "USD"}
$ nameocean domains check kahvebot.com

O registo é feito com POST /domains e é pago com o crédito da conta, por isso também precisa do escopo billing:write. O resto desta página usa um domínio que já tem no DNS da NameOcean.

3. Adicionar um registo DNS

curl
$ curl -X POST https://nameocean.net/api/v1/dns/example.com/records \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY" -H "Content-Type: application/json" \
    -d '{"type": "A", "hostname": "app", "ip": "203.0.113.10", "ttl": "5m"}'
{"id": 4183, "type": "A", "hostname": "app", "ip": "203.0.113.10", "ttl": "5m"}
$ nameocean dns add example.com A app 203.0.113.10 --ttl 5m
$ dig +short app.example.com @ns1.nameocean.net
203.0.113.10

Os nameservers respondem com o novo registo em segundos. hostname é relativo à zona: @ é o próprio example.com. Altere-o com PATCH /dns/example.com/records/A/4183 e elimine-o com DELETE no mesmo caminho.

4. Receber um webhook

Indique à NameOcean para onde enviar os eventos DNS. O URL tem de ser HTTPS num endereço público; a resposta inclui o segredo de assinatura, apenas uma vez.

curl
$ curl -X POST https://nameocean.net/api/v1/webhooks \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY" -H "Content-Type: application/json" \
    -d '{"url": "https://example.com/hooks/nameocean", "events": ["dns.*"]}'
{"id": 12, "url": "https://example.com/hooks/nameocean", "events": ["dns.*"], "active": true,
 "secret": "whsec_…", …}
$ curl -X POST https://nameocean.net/api/v1/webhooks/12/test -H "Authorization: Bearer $NAMEOCEAN_API_KEY"
{"id": "whd_…", "event": {"type": "webhook.test", …}, "status": "succeeded", "response_status": 200, …}

Agora altere o registo do passo 3 e o seu endpoint recebe um evento dns.record.updated com o registo antes e depois. Verifique o cabeçalho X-NameOcean-Signature antes de confiar numa chamada: código de verificação para Python, Node e Go.

5. Ou deixe a sua IA fazê-lo

Tudo o que está acima também é uma ferramenta no servidor MCP. No Claude Code:

Claude Code
$ claude mcp add --transport http nameocean https://nameocean.net/mcp
> Point app.example.com to 203.0.113.10 and tell me when the nameservers have it.

Próximo

  • Referência da API: todos os endpoints, os seus escopos, campos e erros
  • Guias: certificados wildcard com DNS-01, email recebido na sua aplicação, deploy com git push
  • DNS como código: a zona inteira num único ficheiro no git
  • Changelog: novidades