快速入门

1. 注册账号

访问 注册页面，使用邮箱或手机号完成注册。注册成功后自动登录。

2. 获取 API Key

登录后进入 控制台 → API 密钥 页面，系统已为您自动创建一个默认密钥。您也可以创建新的密钥用于不同项目。

3. 密钥格式

API Key 格式为 sk- 开头的 48 位字符串，请妥善保管，不要泄露到公开仓库。

使用 cURL 发起请求

curl -X GET "https://api.apibyte.cn/v2/ip?ip=8.8.8.8" \
  -H "Authorization: Bearer sk-your-api-key"

使用 JavaScript

const res = await fetch('https://api.apibyte.cn/v2/ip?ip=8.8.8.8', {
  headers: { 'Authorization': 'Bearer sk-your-api-key' }
});
const data = await res.json();
console.log(data);

将 sk-your-api-key 替换为您在控制台获取的真实密钥。

统一响应结构

所有接口均返回统一的 JSON 格式：

{
  "code": 0,        // 0 表示成功，非 0 表示错误
  "message": "ok",  // 状态描述
  "data": { ... }   // 业务数据
}

分页响应

列表类接口支持分页，返回格式包含 items、total、current_page、per_page、last_page 字段。

HTTP 状态码

• 200 - 请求成功
• 401 - 未认证或 API Key 无效
• 403 - 无权限访问该接口
• 422 - 参数验证失败
• 429 - 请求频率超限
• 500 - 服务器内部错误

错误响应示例

{
  "code": 40100,
  "message": "API Key 无效或已过期",
  "data": null
}

建议在代码中统一封装错误处理逻辑，根据 code 字段判断业务状态。