我们在调用API域名验证接口的时候, 核心的操作流程是第一步先构造HTTP请求, 第二步是传入需要去验证的那个域名, 第三步是去解析JSON格式的响应内容, 以便拿到最终那个验证结果。
下面的这些说明内容, 是完全基于gname.xin这个平台当前还在生效的那个接口规范来写的, 并且这个规范的版本号明确就是v2.4, 所以说所有已经接入了这个域名验证能力的相关开发者, 都完全适用以下的这套规则说明。
接口地址与鉴权
请求地址:https://api.gname.xin/v2/domain/verify
请求方法是采用的那种POST的方式。
鉴权方式是这样的, 具体做法就是在Header里面, 携带上Authorization这个信息, 并且这个信息的值要是Bearer后面接着一个access_token。
数据格式:Content-Type 固定为 application/json
关于怎样去把那个access_token给获取过来, 然后再去进行续期的相关规则, 你可以去看看gname.xin上面的开发者文档。你要去找一找那个名叫“鉴权中心”的章节, 里面的内容看得非常清楚。
请求参数
这个请求部分的样本情况, 如下所示。
{
"domain": "gname.xin",
"verify_type": "https",
"expect_ip": "203.0.113.10"
}
响应参数
已成功返回响应, 其中状态码为HTTP 200。
{
"code": 0,
"msg": "success",
"data": {
"domain": "gname.xin",
"verified": true,
"ssl_valid": true,
"ssl_expire": "2026-12-01T00:00:00Z",
"ip": "203.0.113.10",
"ip_match": true,
"http_status": 200,
"response_time_ms": 87
}
}
关键字段说明:
表示综合的验证环节有没有完全过关, 这个字段的含义是判断整体状况的一个开关, 要么就是已经成功通过的状态, 要不然就是还没到位的情况存在, 它是一个用来确认最终结果是否合法存在的逻辑判定标识符。
ssl_valid:SSL证书是否处于有效状态
ip_match:实际IP是否与 expect_ip 一致
response_time_ms指的是从服务端一直到目标域名那边, 所需要花费的时间长短, 这个时间长短是用毫秒这个单位来计算的。
常见错误码
调用限制
每个账号的每秒查询率的上限是50次每秒钟, 如果超过这个数值就会返回4293这个代码。
用户能够每天免费使用 1000 次验证请求。当使用的次数超过这个数目之后, 系统会按照 gname.xin 平台的计费方案, 从用户的账户余额中扣除相应的费用。
单次请求超时, 服务端等待目标域名的最大时间为10秒。
注意事项
1. 在verify_type这个字段等于http的时候, SSL相关的字段, 具体包括ssl_valid和ssl_expire, 会返回null, 这种情况属于正常现象。
2. 批量验证场景请使用 POST /v2/domain/verify/batch 接口,单次最多传入 200 个域名。
3. 把所有有关时间的那些字段, 全部都统一改成像UTC这种标准的ISO 8601格式的样子API域名验证接口,然后在前端做展示的时候呢, 大家一定要记得去把时区那边给转换过来。
如果您想获取完整的接口文档以及与 SDK 的示例代码的话, 您可以在 gname.xin 的开发者中心那里进行获取, 这个开发者中心的网址是 developer.gname.xin, 它不仅支持使用 Python 这种语言来进行开发,还支持 Java、Go、Node.js 等另外三种语言的使用。

