LogoJIANZHANZIYOU

API 文档

JIANZHANZIYOU 完整 API 文档

API 文档

Token 认证

所有 API 请求都需要使用有效的 API token 进行身份验证。您可以在 JIANZHANZIYOU 控制台中生成和管理您的 token。

获取您的 API Token

  1. 登录您的 JIANZHANZIYOU 账户
  2. 导航到控制面板中的 API 部分
  3. 为您的网站生成新的 token
  4. 复制 token 并保持安全

认证头部

在请求头中包含您的 API token：

Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

Token 安全

  • 保持您的 API token 安全，永远不要在客户端代码中暴露它们
  • 定期重新生成 token 以确保安全
  • 为不同的环境使用不同的 token（开发、测试、生产）

API 端点

基础 URL

https://api.jianzhanziyou.com/v1

网站管理

获取网站信息

GET /websites/{website_id}

响应：

{
  "id": "website_123",
  "name": "我的网站",
  "domain": "example.com",
  "status": "active",
  "created_at": "2024-01-01T00:00:00Z"
}

更新网站设置

PUT /websites/{website_id}

请求体：

{
  "name": "更新的网站名称",
  "settings": {
    "theme": "default",
    "language": "zh"
  }
}

内容管理

创建页面

POST /websites/{website_id}/pages

请求体：

{
  "title": "新页面",
  "content": "<div>页面内容</div>",
  "template": "default",
  "status": "published"
}

更新页面

PUT /websites/{website_id}/pages/{page_id}

删除页面

DELETE /websites/{website_id}/pages/{page_id}

模板管理

列出模板

GET /templates

响应：

{
  "templates": [
    {
      "id": "template_1",
      "name": "商务模板",
      "category": "business",
      "preview_url": "https://preview.example.com/template_1"
    }
  ]
}

应用模板

POST /websites/{website_id}/apply-template

请求体：

{
  "template_id": "template_1",
  "customize": {
    "colors": {
      "primary": "#007cba",
      "secondary": "#666666"
    }
  }
}

错误处理

HTTP 状态码

  • 200 - 成功
  • 201 - 已创建
  • 400 - 错误请求
  • 401 - 未授权
  • 403 - 禁止访问
  • 404 - 未找到
  • 422 - 无法处理的实体
  • 500 - 内部服务器错误

错误响应格式

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "请求无效",
    "details": {
      "field": "email",
      "issue": "邮箱格式无效"
    }
  }
}

常见错误码

  • INVALID_TOKEN - API token 无效或已过期
  • INSUFFICIENT_PERMISSIONS - Token 没有所需权限
  • RESOURCE_NOT_FOUND - 请求的资源不存在
  • RATE_LIMIT_EXCEEDED - 请求过多，请减慢速度
  • VALIDATION_ERROR - 请求数据验证失败

速率限制

API 请求限制为：

  • 已认证请求每小时 1000 次
  • 未认证请求每小时 100 次

响应中包含速率限制头部：

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200