API和文档

一个密钥。所有模块。

大多数商业软件为每个产品提供一个 API——一个用于收银台,一个用于库存,一个用于发票,每个都有自己的身份验证和日期概念。Kardopal 只有一个。相同的密钥、相同的基本 URL 和相同的查询语法可访问 29 个模块中的 129 个资源。

29
模块
129
资源。
1
密钥,一个基础URL
200
每页最大行数

为何此API值得您投入开发

这里有六件事是真的,而通常不是。

自解释

访问基础 URL,API 将返回其自身的目录 — 您的密钥可见的每个模块、其中的每个资源,以及哪些字段可搜索、哪些可筛选。您不需要此页面来编写集成;您需要它来决定是否集成。

真正有效的权限管理

应用中的范围、路由和权限标签均从一个列表中生成,因此,除非有相应的后端接口,否则无法提供权限。密钥范围限定为 项目 获取项目——请求工资单会返回403错误,而不是一个空白页面。

统一查询语法,无处不在

搜索, 自, 直至, 跳过 和 获取 在发票和库存变动中含义一致。掌握一次,133 项资源均可依此响应。

您的租户,且仅属于您

每个表都带有一个租户 ID,并且每个查询在到达数据库之前都限定在密钥自己的租户范围内。不存在跨租户读取出错的情况,因为没有参数可以请求这样的读取。

字段保持数据真实性

字段列表在启动时从实时模式读取,而非手动维护。新列会自动显示;删除的列绝不会在文档中留下悬空引用,也不会在首次调用时导致500错误。

只读,有目的

密钥只读,从不写入。错误的集成不会使发票作废或移动库存。任何更改记录的操作都通过应用或员工登录进行,并归属于个人,记录在审计日志中。

一次请求开始

一切皆为 GET 请求。如果您可以使用 curl,您可以使用此功能。

获取 /api/v1密钥可见的完整目录
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
获取 /api/v1/me权限探查——这是谁的密钥,能读取什么
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
获取 /api/v1/items?search=lamp&take=2任何资源,统一格式。
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
获取 /api/v1/meta/counts每种资源的行数 — 查看实际存在的数据
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

五个参数

参数功能备注
搜索跨资源可搜索字段的不区分大小写匹配。哪些字段已列在 /meta
自仅从此日期起的记录适用于资源排序的字段
直至仅记录截至此日期结合使用 自 针对某个窗口
跳过偏移到结果集默认为0
获取返回行数默认50,上限200

资源也接受对其自身声明字段的精确匹配筛选 — ?status=已支付, ?warehouseId=… — 并且每个都标明了是哪些。每个列表响应都包含 总计 和 更多,因此分页是一个循环,而不是猜测。

API可触及的范围

29 个模块,129 项资源。每张卡片代表您可以授予密钥的一项权限——灰色标签表示相同记录在您手机应用中的位置。

联系人

2

客户、供应商以及他们所属的细分市场。

联系人联系人细分
联系人 联系人

商品

7

商品目录:产品、变体、品牌、价格表和单位。

项目类别品牌商品变体价格表单位+1更多
项目 商品

库存

7

仓库、库存水平、库存移动、批次、序列号和货位。

仓库库存移动库存水平批次序列号库存盘点+1更多
库存 库存

销售

7

发票、估价单、订单、贷项通知单及付款。

发票估价单销售订单贷项通知单支付循环发票+1更多
销售 销售

POS

11

收银机、班次、收据、餐桌和每一笔柜台交易。

POS销售POS 班次POS 终端POS用户POS餐桌POS餐桌区域另有5项
pos POS

CRM

4

销售线索、交易、销售漏斗和提案。

销售线索交易业务流程提案
crm CRM

采购

5

采购订单、申请、退货、账单和供应商付款。

采购订单采购请求采购退货账单供应商付款
采购 采购

财务核算

5

费用、银行账户、交易和税率。

费用费用类别银行账户bank-transactions税率
财务 财务核算

营销

4

营销活动、收件人、着陆页和表单提交。

营销活动营销活动接收者落地页表单提交
营销 营销

HR

8

人员、部门、请假、工资单、考勤和招聘。

员工部门leave-requests工资单考勤招聘信息另有 2 项
hr HR

工时表。

2

时间条目及其对应的项目。

时间记录工时表项目
工时表 工时表。

项目

3

项目、阶段及其相关成本。

项目项目阶段项目成本
项目 项目

预约

3

预约、可预订服务以及提供服务的员工。

预订预订服务预订员工
预订 预约

现场服务

7

工作、技术人员、工单、合同和设备。

现场工作技术人员服务请求服务合同工单工单+1更多
现场服务 现场服务

物流

5

货物、司机、车辆、区域和承运商。

货运司机车辆配送区域承运商
物流 物流

服务台

5

工单、SLA 策略、帮助文章与知识库。

订单客户工单帮助文章知识库SLA 政策
支持 服务台

售后

5

退货、保修索赔、维修和产品注册。

退货管理保修索赔保修登记维修产品注册
售后 售后

租赁

3

可租赁资产、租赁协议及其明细。

资产租赁rental-lines
租赁 租赁

餐厅

2

菜单及基于菜单的订单。

菜单项菜单订单
餐厅 餐饮

排队

5

票务、服务、柜台、分支机构和显示屏。

排队票排队服务排队计数器队列分支排队显示屏
队列 排队

忠诚度

6

会员、账户、层级、奖励和积分交易。

loyalty-members会员账户忠诚度奖励会员等级忠诚度交易loyalty-coupons
会员忠诚度 忠诚度

地点

2

站点和分支机构。

地点分支机构
地点 地点

IOT

6

设备、站点、盒子、警报、事件和标牌内容。

物联网设备iot-sites物联网警报物联网事件物联网盒子物联网标牌内容
iot 物联网中心

AI 工作室

3

生成的资产、包含它们的项目和作业历史。

AI资产AI项目ai-jobs
ai_studio AI 工作室

商务

3

网络成员、报价请求和收款。

网络成员报价请求系列
商业 商务

电子签名

2

签名请求及收集到的签名。

签名请求签名
签名 电子签名

审批

2

审批请求及其路由规则。

审批请求审批规则
审批 审批

文件

2

上传文件和扫描文档。

文件扫描文件
文件 文件

活动

3

活动动态、审计日志和通知。

活动审计日志通知
电话沟通

API 读取的每个模块,您的团队都能在手中打开

这通常是虚假宣传。许多平台都提供广泛的API,然后发布一个只能做三件事的移动应用——审批、查看、通知。Kardopal的应用是产品本身,而非辅助工具:以上所有29个模块都有真实的界面,大部分工作实际上都在手机上完成。

  • 阅读后立即行动。您的集成拉取库存水平;负责解决问题的人员打开同一记录,进行调整并以其名义签署。
  • 扫描、拍摄、签名。条形码扫描、文档捕获和电子签名是手机原生功能——桌面端没有值得使用的同等功能。
  • 收银台离线也能正常工作。即使网络连接不稳定,收银机、厨房显示屏和排队显示屏也能持续提供服务。
  • 相同的登录,相同的数据,20种语言。 包括从右到左的语言,因此阿拉伯语团队不会看到镜像布局。
查看平台。
手机上的Kardopal应用

获取密钥

打开应用,前往平台 → API 密钥。密钥由您租户的所有者或管理员创建。Kardopal 的任何人都不会为您颁发密钥。
只勾选集成所需的模块。一个橱窗小部件需要 项目。它不需要 hr. 窄密钥故障安全。
将其作为请求头发送,绝不要放在URL中。X-API-Key: kp_live_… — 查询字符串会出现在日志、代理和浏览器历史记录中。
先创建新密钥再轮换。两者同时工作,因此您可以转移流量并撤销旧的,而不会出现停机窗口。

在此基础上构建

API 自我文档:在应用中创建密钥,然后指向 curl 在基础URL,它会返回该密钥可以访问的每个模块、资源和可搜索字段。

创建 API 密钥