浏览分类

API 概述与认证

API 文档
2026/1/18
481 次阅读

API 概述与认证

简介

我们的 REST API 允许你以编程方式访问和管理资源。

Base URL: https://api.kygeehub.com/v1

认证方式

API Key

在请求头中添加:

X-API-Key: your_api_key_here

Bearer Token

对于需要用户上下文的操作:

Authorization: Bearer your_access_token

获取 API Key

  1. 登录 开发者控制台
  2. 点击「创建 API Key」
  3. 设置权限范围
  4. 安全保存生成的密钥

请求格式

  • 所有请求使用 JSON 格式
  • 字符编码:UTF-8
  • 时间格式:ISO 8601
curl -X GET "https://api.kygeehub.com/v1/users" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json"

响应格式

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "total": 100
  }
}

错误处理

状态码含义
400请求参数错误
401未授权
403权限不足
404资源不存在
429请求过于频繁
500服务器错误