跳到主要内容

发起第一次请求

先通过免费的 WHOIS 覆盖查询验证密钥,再查询域名。请在终端或后端运行这两个示例。

1. 准备项目​

打开控制台的 API 密钥页面,选择组织和项目,创建项目 API 密钥。请在签发时保存完整密钥。

2. 配置后端​

通过服务端环境变量或 Secret Manager 提供项目密钥:

变量值
ANTAPI_KEY你的项目 API 密钥。

本机终端中,将占位值替换为你的密钥:

export ANTAPI_KEY="your-project-key"

官方 Gateway 为 https://api.antapi.dev。Skills 和 CLI 自动使用该地址,无需配置 Gateway。包括免费端点在内,所有请求都通过 Authorization 请求头传递密钥。

密钥只能保存在服务端

请在可信终端或后端运行示例。不要把 API 密钥放入浏览器构建产物、公开仓库、截图或日志。

3. 用免费请求验证接入​

curl --include \
"https://api.antapi.dev/whois/v1/tlds" \
--header "Authorization: Bearer $ANTAPI_KEY"

此请求查询 TLD 覆盖范围,不消耗 Credits,但仍需认证并受速率限制。成功 JSON 响应包含 code: 0。覆盖字段说明见 TLD 参考。

4. 查询域名​

发出此付费请求前,请检查正式查询价格、Credits 余额和项目可用预算:

curl --include \
"https://api.antapi.dev/whois/v1/domains/example.com" \
--header "Authorization: Bearer $ANTAPI_KEY"

完整 WHOIS 流程,包括 TLD 覆盖和结果解读,见 WHOIS 概览与接入。其他产品的指南与参考文档可从文档首页选择。

5. 检查响应和用量​

检查 HTTP 状态与 JSON 信封。成功响应包含 code: 0、端点对应的 data 和空字符串 error。异步任务的受理响应只表示开始处理,不确认任务已完成或已最终扣费。

保存响应头 X-Request-ID 以便排查。打开用量与请求记录查看请求和最终付费凭证。Credits 与计费说明预留与最终扣费的区别。

上线前​

  • 遵循 API 密钥安全指南,在需要独立管理访问时使用不同密钥。
  • 在异步提交或可能重试的付费请求前,保存稳定的幂等 Key。
  • 通过明确的退避与恢复策略处理限流、错误和不确定结果。
  • 在统计结果或决定重试之前,阅读产品的成功定义与完整 API 参考。