开发文档
欢迎使用 Apiorbit 开发文档。快速集成 API，构建您的应用。
快速开始
1
2
3
调用 API
在请求头中添加 x-api-key 或在 URL 参数中添加 api_key 即可调用 API。
JavaScript
// 方式一：请求头认证（推荐）
fetch('https://api.apiorbit.com/api/ip', {
headers: {
'x-api-key': 'YOUR_API_KEY'
}
})
.then(res => res.json())
.then(data => console.log(data));
// 方式二：URL 参数认证
fetch('https://api.apiorbit.com/api/ip?api_key=YOUR_API_KEY')
.then(res => res.json())
.then(data => console.log(data));认证方式
所有 API 请求都需要进行身份验证。我们支持两种认证方式：
推荐
请求头认证
在 HTTP 请求头中添加 x-api-key 字段，安全性更高。
x-api-key: fap_xxxxxxxxxxxxURL 参数认证
在 URL 中添加 api_key 参数，适用于简单测试场景。
?api_key=fap_xxxxxxxxxxxx限流规则
为了保证服务的稳定性，我们对 API 调用进行了限流：
100
次/分钟
用户级限制
基于 API Key 的请求频率限制
60
次/分钟
IP级限制
基于客户端 IP 的请求频率限制
提示：超过限制后，将返回 429 状态码。建议在客户端实现请求队列或指数退避重试机制。
错误码说明
| 状态码 | 说明 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求参数错误 |
| 401 | 未授权，API Key无效或缺失 |
| 403 | 禁止访问，账户被禁用 |
| 404 | 资源不存在 |
| 429 | 请求过于频繁，触发限流 |
| 500 | 服务器内部错误 |