金心诺文档

深色模式

端点参考 ​

只有三个端点，全部为 GET，全部只读。资源名是固定值，见下表。

1. 元信息 ​

http
GET /api/open/v1/meta

返回认证方式、只读标记、当前 Key 的信息与全部可用资源：

json
{
  "code": 200,
  "message": "success",
  "data": {
    "auth": "X-API-Key: uak_<密钥编号>_<密钥内容>",
    "read_only": true,
    "resources": [
      { "key": "tickets", "name": "客服工单", "desc": "客服工单列表与详情（只读）", "read_only": true,
        "columns": ["id", "ticket_no", "title", "status", "priority", "source", "assignee_name", "created_at"],
        "filters": ["priority", "status"] }
    ],
    "key": { "key_id": "a1b2c3", "name": "BI 报表", "owner_scope": "customer-a", "rpm": 60 }
  }
}

对接前先调这个端点，用返回的 key 字段确认资源名与配额，用 key.rpm 确认当前上限。

2. 资源列表 ​

http
GET /api/open/v1/{resource}
参数说明
page页码，从 1 开始，默认 1
page_size每页条数，默认 20，上限 100
q关键词，按该资源的标题字段模糊匹配
filter等值过滤，格式 filter=字段:值，可重复传
status / level / priority常用过滤键的快捷写法，等价于对应的 filter

按 id 倒序返回。响应：

json
{
  "code": 200,
  "message": "success",
  "data": {
    "list": [ { "id": 1024, "ticket_no": "T202610240001", "title": "设备离线", "status": "open" } ],
    "total": 128,
    "page": 1,
    "page_size": 20
  }
}

翻页到底的判定用 page * page_size >= total，不要用「返回条数小于 page_size」判断，两者在数据变动时结论可能不同。

3. 资源详情 ​

http
GET /api/open/v1/{resource}/{id}

id 必须是整数。返回该资源的详情字段；记录不存在或不在你的数据范围内，统一返回 404 not_found。

4. 资源与字段 ​

知识库 knowledge_bases ​

字段说明
id知识库编号
name名称，也是关键词匹配字段
description描述
chunk_mode分段方式（仅详情）
status状态
owner_scope归属范围
created_at / updated_at创建与更新时间（updated_at 仅详情）

客服工单 tickets ​

字段说明
id工单编号
ticket_no工单号
title标题，也是关键词匹配字段
detail问题描述（仅详情）
status状态
priority优先级
source来源渠道
assignee_name处理人
note处理备注（仅详情）
resolved_at解决时间（仅详情）
created_at / updated_at创建与更新时间

可用过滤：status、priority。

告警 alerts ​

字段说明
id告警编号
level级别
source来源
title标题，也是关键词匹配字段
status状态
target_name告警对象
created_at产生时间

可用过滤：level、status。

客服渠道 channels ​

字段说明
id渠道编号
name渠道名称，也是关键词匹配字段
type渠道类型
owner_scope归属范围
enabled是否启用
created_at创建时间

渠道的密钥与接入参数不在返回字段内，需要时到后台渠道页面查看。

5. 调用示例 ​

bash
# 拉最近一页高优先级工单
curl -s "https://jinxino.cn/api/open/v1/tickets?priority=high&page=1&page_size=100" \
  -H "X-API-Key: uak_xxxxxxxx_yyyyyyyyyyyyyyyy"

# 取一条工单详情
curl -s "https://jinxino.cn/api/open/v1/tickets/1024" \
  -H "X-API-Key: uak_xxxxxxxx_yyyyyyyyyyyyyyyy"

相关文档 ​