开发者 → 快速入门

快速入门

只需五分钟:一个 API 密钥、一次域名可用性查询、一条 DNS 记录,以及一个在记录变更时通知您代码的 webhook。每一步均可使用 curl 或 nameocean CLI 完成。

1. 获取密钥

打开控制面板 → API 密钥,创建一个具有 account:read、domains:read、dns:write 和 webhooks:write 权限的密钥。密钥仅显示一次。使用密钥需要您的账户开启两步登录。

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}

使用 CLI 时可以无需密钥:nameocean login 会通过浏览器登录。安装方式:brew install nameocean/tap/nameocean 或 curl -fsSL https://nameocean.net/install.sh | sh。

nameocean
$ nameocean login
$ nameocean account

2. 查询域名

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

注册域名使用 POST /domains,费用从账户余额中扣除,因此还需要 billing:write 权限范围。本页其余部分使用您已托管在 NameOcean DNS 上的域名。

3. 添加 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

名称服务器会在几秒内返回新记录。hostname 相对于区域:@ 即 example.com 本身。使用 PATCH /dns/example.com/records/A/4183 修改记录,对同一路径使用 DELETE 删除记录。

4. 接收 webhook

告诉 NameOcean 将 DNS 事件发送到哪里。URL 必须是公网地址上的 HTTPS;响应中会包含签名密钥,仅显示一次。

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, …}

现在修改第 3 步中的记录,您的端点会收到一个 dns.record.updated 事件,其中包含记录修改前后的内容。在信任任何请求之前,请先校验 X-NameOcean-Signature 请求头:Python、Node 和 Go 的验证代码。

5. 或者交给 AI 来完成

以上所有操作在 MCP 服务器上也都有对应工具。在 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.

下一步

  • API 参考: 所有端点及其权限范围、字段和错误
  • 指南: 使用 DNS-01 获取通配符证书、在应用中接收邮件、通过 git push 部署
  • DNS 即代码: 在 git 中用一个文件管理整个区域
  • 更新日志: 最新动态