QamaqQamaq

Qamaq API 文档

使用 Qamaq API 构建强大的集成。访问实体、知识库、工作流等。

快速开始

1

获取 API 密钥

在 Qamaq 仪表板中导航至「配置 > API 密钥」以创建新的 API 密钥。请务必立即复制，因为密钥不会再次显示。

2

发送第一个请求

在 Authorization 请求头中使用 Bearer 方案携带您的 API 密钥：

请求示例bash
curl -X GET "https://api.qamaq.io/api/v1/entities" \
  -H "Authorization: Bearer qmq_your_api_key"
3

探索 API

浏览下方的 API 参考文档，了解所有可用的端点和功能。

API 能力

API 密钥认证

使用 Bearer token 认证的 API 密钥保护您的请求。

看板

访问和管理包含列和工作流阶段的看板。

工单

在看板上创建、更新、移动和管理工单。

自定义实体

创建、读取、更新和删除自定义实体及其记录。

文件夹

使用文件夹和层级结构组织您的知识库。

文件

上传、管理和检索知识库中的文件。

语义搜索

在知识库中执行 AI 驱动的语义搜索。

Webhook

配置 webhook 以接收实时事件通知。

基础 URL

所有 API 请求应发送至：

https://api.qamaq.io/api/v1

API 版本管理

API 版本包含在 URL 路径中。当前稳定版本为 v1。

我们会提前公告任何破坏性变更，并尽可能保持向后兼容。

速率限制

API 实施速率限制以确保公平使用。当前限制：

1000

请求/分钟

10,000

请求/小时

100,000

请求/天

注意： 速率限制头信息包含在所有响应中。如果超出限制，您将收到 429 Too Many Requests 响应。如需更高限额，请联系我们。

错误处理

API 使用标准 HTTP 状态码指示请求的成功或失败：

200OK请求成功
201Created资源创建成功
400Bad Request请求参数无效
401Unauthorized缺少或无效的 API 密钥
403ForbiddenAPI 密钥缺少所需权限
404Not Found资源未找到
422Validation Error请求验证失败
429Too Many Requests超出速率限制
500Server Error内部服务器错误

需要帮助？

我们的团队随时帮助您集成 Qamaq API。

联系支持查看文档