API 概览

API 基础信息

• Base URL：https://api.zhiqiyungong.com
• 协议：HTTPS（所有请求必须使用 HTTPS）
• 数据格式：JSON（请求和响应均使用 JSON）
• 字符编码：UTF-8
• API 版本：当前为 v1，版本号在 URL 路径中体现

认证方式

智企云工 API 使用 Bearer Token 认证。每次请求需要在 HTTP Header 中携带有效的 Access Token。

获取 Token

POST /api/login
Content-Type: application/json

{
  "username": "your_username",
  "password": "your_password"
}

// 响应
{
  "code": 0,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIs...",
    "token_type": "Bearer",
    "expires_in": 86400,
    "tenant_id": "tnt_7x2m9p1q"
  }
}

携带 Token 发起请求

GET /api/kf/knowledge/list
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
X-Tenant-Id: tnt_7x2m9p1q

⚠️ 注意：Access Token 有效期 24 小时。过期后返回 401 错误，需要重新登录获取新 Token。建议在应用中实现自动刷新机制。

统一响应格式

所有 API 响应遵循统一格式：

{
  "code": 0,              // 状态码，0 表示成功
  "message": "操作成功",   // 提示信息
  "data": { ... },        // 业务数据（成功时）
  "error": null           // 错误详情（失败时）
}

常见状态码

速率限制

• 免费版：100 次/分钟
• 专业版：1,000 次/分钟
• 企业版：5,000 次/分钟

请求超限时，API 会返回 429 状态码，并在响应头中提供 Retry-After 字段，告知下次请求可以发起的时间（秒）。

API 列表速查