快速入门
几分钟内跑通一次可用的 GET /v1/geo 调用:创建密钥、发起请求并读取响应。
开始之前
- 一个 Watch-IP 账户——免费方案即可跟随本指南操作。
- 一个可以添加 fetch 或 curl 调用的页面或脚本。
1. 创建账户并获取密钥
注册并打开您的控制台。每个账户都会预先获得一个公开可用的访问者密钥——请配置其允许的来源,使其包含您将要调用它的站点(测试期间可使用 localhost)。
2. 发起您的第一个请求
在 X-Api-Key 请求头中携带您的公开可用密钥调用 GET /v1/geo。从浏览器发起时,解析的是访问者自己的连接;从服务器发起时,解析的则是服务器自身的连接。
curl
curl https://api.watch-ip.com/v1/geo \
-H "X-Api-Key: YOUR_PUBLISHABLE_KEY"3. 读取响应
成功的调用会返回状态码 200 及一个 JSON 响应体——country、city 和 timezone 是大多数集成最先用到的字段,且每个字段都可能独立为 null,请在使用前先行判断。
响应(节选)
{
"ip": "203.0.113.1",
"country": "US",
"city": "Austin",
"timezone": "America/Chicago"
}4. 查询其他 IP
需要解析一个您已经掌握的地址,而不是当前连接的访问者?这是另一个使用密钥(而非公开可用密钥)进行身份验证的服务器到服务器端点——请参阅 IP 查询参考。
如果出现问题
401 表示 API 密钥缺失或无效;GET /v1/geo 返回 403 通常意味着调用来源尚未加入该密钥的允许来源列表。完整状态码列表请参阅错误与速率限制。
下一步
阅读身份验证了解密钥类型与来源锁定的工作原理,或直接前往端点参考查看您正在对接的响应内容。