API简介

我们的API服务提供了一系列接口，帮助开发者快速集成各种功能到自己的应用中。所有API都遵循RESTful设计规范，使用JSON格式进行数据交换。

基本信息

所有API请求的基础URL为：

https://api.uctb.cn/v5

API支持的请求方法：

• GET - 获取资源
• POST - 创建资源
• PUT - 更新资源
• DELETE - 删除资源

所有API响应均采用JSON格式，包含以下基本结构：

{
  "code": 200,          // 状态码，200表示成功
  "message": "success", // 状态描述
  "data": { ... }       // 具体数据
}

快速开始

按照以下步骤，快速开始使用我们的API服务：

步骤1：注册账号

首先，您需要在平台注册一个账号，注册成功后即可获得使用API的权限。

步骤2：获取API密钥

登录后，进入API密钥管理页面，创建并获取您的API密钥。API密钥是调用API的重要凭证，请妥善保管。

步骤3：调用API

使用您的API密钥，按照文档说明调用相应的API接口。以下是一个简单的示例：

// 使用curl调用示例
curl -X GET "https://api.uctb.cn/v5/user/profile" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

// 使用JavaScript调用示例
fetch('https://api.uctb.cn/v5/user/profile', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

身份验证

我们的API使用Bearer Token进行身份验证。在调用需要权限的API时，您需要在请求头中包含有效的API密钥。

Authorization: Bearer YOUR_API_KEY

API密钥管理

• 每个账号可以创建多个API密钥，便于在不同应用中使用
• 您可以随时禁用或删除某个API密钥
• 建议定期更换API密钥以提高安全性
• 如果怀疑API密钥泄露，请立即删除并创建新的密钥

未授权访问

如果请求未包含有效的API密钥，将返回401错误：

{
  "code": 401,
  "message": "Unauthorized: Invalid or missing API key",
  "data": null
}