API文档

全面的API接口文档,帮助您快速集成我们的服务

介绍

我们的API提供了一套完整的RESTful接口,允许您与我们的平台进行程序化交互。所有API调用均通过HTTPS进行,并使用JSON格式返回数据。

根URL

所有API请求的根URL为:https://api.horysk.com/v1

身份验证

所有API请求都需要有效的API密钥。您可以在账户设置中生成API密钥。

Authorization: Bearer YOUR_API_KEY

API端点

GET /users/{id}

获取特定用户的详细信息

参数

参数 类型 必需 描述
id String 用户ID
POST /data/process

处理数据请求

请求体

{
  "input_data": "string",
  "options": {
    "param1": "value1",
    "param2": "value2"
  }
}

代码示例

以下是使用JavaScript进行API调用的示例:

const response = await fetch('https://api.horysk.com/v1/users/123', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const userData = await response.json();
console.log(userData);

速率限制

为确保服务质量,我们对API调用设置了速率限制:

  • 每分钟最多100次请求
  • 每小时最多5000次请求
  • 每天最多100,000次请求

错误处理

当API请求失败时,将返回适当的HTTP状态码和错误详情:

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "请求参数无效",
    "details": "字段 'email' 是必需的"
  }
}

更新日志

v1.2.0 - 2023-11-15

  • 新增数据处理API
  • 改进错误响应格式

v1.1.0 - 2023-08-22

  • 添加用户管理API
  • 增强安全性措施