接口概述

查询域名注册信息, 也就是查看WHOIS数据的时候, 最方便的做法就是去调用API接口, 这里拿gname.xin这个域名的WHOIS信息查询API当作一个标准的例子来说事, 把完整的调用步骤、需要提交的请求参数以及最终返回的那些内容字段都讲清楚一下, 好让开发人员能够把这个东西直接集成到自己所在的业务系统里面去。

调用方式

接口地址:https://api.gname.xin/v1/domain/whois

请求方式:GET

API接口查域名注册信息,调用参数与步骤一篇搞懂(图1)

鉴权:请求头携带 Authorization: Bearer {API_KEY}

你在gname.xin的开发者后台那边完成应用的创建动作之后, 就可以获取到那个叫做API_KEY的东西, 而且针对每一个单独的应用, 都会有各自独立使用的配额额度。

请求参数

参数 必填 说明
domain 是 待查询域名,如 example.com
lang 否 返回语言,zh-CN / en-USAPI接口域名注册查询,默认 zh-CN
raw 否 是否返回原始WHOIS记录API接口域名注册查询,默认 false

返回示例(HTTP 200)

{
  "code": 0,
  "domain": "example.com",
"registrar": "某某注册商",

大城新闻网

"creation_date": "2003-10-17", "expiration_date": "2025-10-16", "status": ["clientTransferProhibited"], "name_servers": ["ns1.example.com", "ns2.example.com"] }

API接口查域名注册信息,调用参数与步骤一篇搞懂(图2)

代码值等于 code=0 的时候, 意味着操作已经成功了;如果返回值不是 0, 就说明出错了, 需要去看一看具体的错误码, 至于那个具体的错误码到底是什么含义的话, 请去查看一下相应的错误码对照表。

关键注意事项

1. 在默认状态之下, 每一个API_KEY会被限制在每分钟最多访问60次。一旦超过这个限额系统就会返回HTTP 429错误代码。遇到这种情况必须采用指数退避的方式进行重试操作。

2. 如果涉及到.cn这样的国内域名查询接口的时候, 系统内部会自动把请求路由分配给CNNIC这个渠道, 这样的话调用方就不需要再去额外处理任何相关的操作了。

API接口查域名注册信息,调用参数与步骤一篇搞懂(图3)

3. 当同一个域名的请求在三百秒的时间内被重复查询的时候, 如果此时命中了缓存服务器里的数据, 那么系统返回给请求方的查询结果会保持高度一致。

扩展资源

Python和Node.js以及Go这几个编程语言的官方SDK, 还有完整的错误码表这些东西, 都可以在gname.xin开发者文档中心获取到。

在接口调用的过程中如果出现了异常情况的话, 需要带上返回体中的 request_id 去联系gname.xin技术支撑人员, 而且他们的工单平均响应时间是小于2小时的这回事。