LogoIPCONFIG 文档

API 密钥管理

创建和管理您的 API 密钥,用于访问 IPConfig 的各种 API 服务

API 密钥管理

API 密钥是访问 IPConfig API 服务的必要凭证。通过 API 密钥,您可以在应用程序中集成我们的 IP 归属地查询、Ping 测试等服务。

获取 API 密钥

1. 登录控制台

首先登录您的 IPConfig 账户,进入控制台。

2. 创建 API 密钥

在控制台中找到 "API 密钥" 页面,点击 "创建新密钥" 按钮。

image

3. 配置密钥信息

  • 密钥名称: 为您的 API 密钥设置一个便于识别的名称

4. 保存密钥

创建成功后,请立即复制并安全保存您的 API 密钥。出于安全考虑,密钥只会显示一次。

API 密钥使用

认证方式

在所有 API 请求中,您需要在请求头中包含您的 API 密钥:

Authorization: Bearer YOUR_API_KEY

支持的 API 服务

使用 API 密钥可以访问以下服务:

IP 归属地查询 API

  • 端点: POST https://ipconfig.com/api/ip-query
  • 功能: 查询任意 IP 地址的详细地理位置信息
  • 消耗: 每次查询消耗 1 积分
  • 文档: IP 归属地查询 API

Ping 测试 API

  • 端点: POST https://ipconfig.com/api/ping
  • 功能: 从全球多个节点测试网络连通性和延迟
  • 消耗: 每个测试节点消耗 1 积分
  • 文档: Ping 测试 API

获取我的 IP API

  • 端点: GET https://ipconfig.com/api/get-my-ip
  • 功能: 获取当前请求的公网 IP 地址
  • 消耗: 免费使用,不消耗积分
  • 文档: 获取我的 IP API

使用示例

# 设置您的 API 密钥
export IPCONFIG_API_KEY='your-api-key-here'

# IP 归属地查询
curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer $IPCONFIG_API_KEY" \
  -X POST "https://ipconfig.com/api/ip-query" \
  -d '{"ip": "8.8.8.8", "lang": "zh"}'

# Ping 测试
curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer $IPCONFIG_API_KEY" \
  -X POST "https://ipconfig.com/api/ping" \
  -d '{"host": "google.com", "areas": ["beijing", "tokyo"], "count": 4}'

密钥管理

查看密钥列表

在 API 密钥页面,您可以查看所有已创建的密钥,包括:

  • 密钥名称
  • 创建时间
  • 最后使用时间
  • 使用统计
  • 状态(启用/禁用)

删除密钥

不再需要的 API 密钥可以永久删除。删除后无法恢复,请谨慎操作。

安全最佳实践

1. 密钥保护

  • 将 API 密钥存储在环境变量中,不要硬编码在代码里
  • 不要在公开的代码仓库中提交 API 密钥
  • 定期轮换 API 密钥

2. 权限控制

  • 为不同的应用创建不同的 API 密钥

3. 监控使用

  • 定期检查 API 密钥的使用情况
  • 监控异常的使用模式
  • 及时禁用可疑的密钥

积分消耗

不同的 API 服务消耗不同数量的积分:

API 服务积分消耗
获取我的 IP免费
IP 归属地查询1 积分/次
Ping 测试1 积分/节点

您可以在 积分管理 页面查看当前积分余额和购买更多积分。

常见问题

Q: API 密钥丢失了怎么办?

A: 出于安全考虑,我们无法找回丢失的 API 密钥。请创建新的密钥并删除旧的密钥。

Q: API 有速率限制吗?

A: 是的,免费用户每分钟最多 60 次请求,付费用户每秒最多 100 次请求。

Q: 如何查看 API 使用统计?

A: 在控制台的 API 密钥页面可以查看每个密钥的使用统计和积分消耗记录。

相关文档