科纳云 开放平台

面向开发者的全套SDK与API文档,覆盖门店管理、支付分账、门禁物联、音视频通信、AI视觉识别、信用代扣、团购服务、O2O服务八大核心能力。

8
平台SDK
60+
API接口
RESTful
接口规范
99.9%
服务可用率
SDK OVERVIEW

八大平台SDK · 全链路开放

每个SDK独立可用又深度协同,开发者可按需选择接入,构建完整的智能门店数字化解决方案

🏪

门店管理 SDK

核心业务中枢API,涵盖商品管理、订单处理、会员体系、营销活动、库存管理、数据报表等全功能接口。

商品CRUD订单管理会员体系营销活动数据统计
查看文档 →
💰

支付分账 SDK

多通道支付分账接口,对接汇付Adapay、易宝YeePay、宝付Baofoo等主流支付渠道,自动化资金分配与结算。

Adapay易宝YeePay宝付商户入驻自动结算
查看文档 →
🔐

门禁物联 SDK

MQTT协议驱动的IoT设备管理API,支持设备影子、OTA升级、连接管理、远程控制,适配RK3308/ML307R等硬件。

MQTT设备影子OTA升级远程控制BLE蓝牙
查看文档 →
📹

音视频通信 SDK

基于WebRTC的实时音视频通话与IM即时通讯接口,支持群组通话、AI语音克隆、TTS语音合成。

WebRTCIM消息AI语音克隆TTS群组通话
查看文档 →
👁️

AI视觉识别 SDK

基于深度学习的商品识别与人脸识别服务API,支持14万+SKU商品秒级识别、安全检测、行为分析。

商品识别人脸识别安全检测行为分析GPU加速
查看文档 →
💳

信用代扣 SDK

信用代扣与团购业务API,集成定时扣款、冻结解冻、团购管理、商户管理等后台能力。

信用代扣定时扣款冻结解冻团购核销商户管理
查看文档 →
🛒

团购服务 SDK

本地生活团购平台API,覆盖团购商品管理、在线下单、到店核销、商家管理、消费者端等全链路团购业务能力。

团购商品在线下单到店核销商家管理营销推广
查看文档 →
💆

O2O上门服务 SDK

上门服务O2O平台全套微服务API,16个微服务覆盖用户、技师、订单、支付、派单、安全保障等。

用户管理智能派单订单流转安全保障积分营销
查看文档 →

通用接入规范

鉴权方式

所有API均需携带鉴权信息。支持两种方式:
1. HTTP Header: Authorization: Bearer {your_api_key}
2. Query参数: ?token={your_api_key}
联系商务获取API Key: 400-0722-878support@konacloud.cn

统一成功响应

{
  "code": 200,
  "message": "success",
  "data": { ... }
}

统一错误响应

{
  "code": 400,
  "message": "参数错误描述",
  "data": null
}

分页参数规范

// 请求
page=1 pageSize=20
// 响应
"total": 150
"totalPages": 8
STORE MANAGEMENT SDK

门店管理 SDK

核心业务中枢,基于PHP微擎框架构建。涵盖商品管理、订单处理、会员体系、营销活动、库存管理、数据报表、WebSocket实时通讯等全功能API。

Base URL: https://kny.keduyunzhishou.com/app/index.php
商品管理订单系统会员体系营销活动数据统计WebSocket萤石监控外卖对接

商品管理 API

GET/goods/list

获取商品列表,支持分类筛选、关键词搜索、分页查询。返回商品名称、价格、库存、条码等信息。

category_idkeywordpagepageSizestatus
GET/goods/detail

获取商品详情,包含规格、库存、图片、条码、称重信息等完整商品数据。

goods_id
POST/goods/create

创建新商品,支持设置价格、分类、规格、库存预警、称重标记等信息。

namepricecategory_idbarcodestock
POST/goods/update

更新商品信息,支持批量修改价格、库存、状态、分类等属性。

goods_idnamepricestock
GET/goods/barcode

条码扫描查询,输入条码返回匹配商品。支持EAN-13、Code128等多种条码格式。

barcode
GET/inventory/check

库存盘点接口,查询库存变动记录,支持按时间范围、商品分类筛选。

merch_idstart_dateend_date

订单管理 API

GET/order/list

获取订单列表,支持按状态、时间、门店筛选。返回订单详情、商品明细、支付信息。

statusmerch_idstart_timeend_timepage
POST/order/create

创建收银订单,提交商品列表和支付方式,支持微信/支付宝/现金/人脸支付。

merch_idgoods_listpay_typetotal_amount
POST/order/refund

订单退款接口,支持全额/部分退款,自动原路退回支付渠道。

order_idrefund_amountreason
GET/statistics/daily

每日营业统计,包含营收、订单数、客单价、支付方式分布等数据。

merch_iddate

会员 & 营销 API

GET/member/info

获取会员信息,包含等级、积分、消费记录、优惠券等数据。

member_idphone
POST/marketing/coupon/send

发放优惠券接口,支持满减券、折扣券、商品券等多种类型。

member_idcoupon_idquantity

WebSocket 实时通讯

Swoole WebSocket 服务

基于Swoole的WebSocket服务器(端口9502),用于客服实时通讯、订单推送、设备状态同步。
连接地址: wss://kny.keduyunzhishou.com:9502

JavaScript - WebSocket连接
const ws = new WebSocket('wss://kny.keduyunzhishou.com:9502');
ws.onopen = () => {
  ws.send(JSON.stringify({
    type: 'auth', token: 'your_api_key', merch_id: 123
  }));
};
ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  // data.type: 'new_order' | 'cs_message' | 'device_alert'
};
PAYMENT SPLIT SDK

支付分账 SDK

基于ThinkPHP框架的多通道支付分账系统,对接汇付天下Adapay、易宝YeePay、宝付Baofoo等主流支付渠道,实现商户入驻、交易分账、自动结算、对账报表。

Base URL: https://fenzhang.keduyunzhishou.com/api
汇付Adapay易宝YeePay宝付Baofoo对账报表风控引擎

商户管理 API

POST/merchant/register

商户入驻注册,提交营业执照、法人信息、银行账户等资料,自动提交至支付渠道审核。

company_namelicense_nolegal_personbank_account
GET/merchant/status

查询商户审核状态与结算信息,包含已结算金额、待结算金额、冻结金额等。

merchant_id

分账交易 API

POST/split/create

创建分账交易,指定分账接收方和金额比例,支持实时分账和延迟分账两种模式。

order_idtotal_amountreceivers[]channel
GET/split/query

查询分账交易结果,返回分账状态、各接收方到账情况、手续费明细。

split_idorder_id
POST/split/receiver/add

添加分账接收方,设置接收方账户和分账比例,支持个人和企业账户。

merchant_idreceiver_accountratiotype
GET/settlement/records

获取结算记录,包含结算周期、结算金额、手续费、到账银行等信息。

merchant_idstart_dateend_datepage
PHP - 创建分账交易
// 创建分账交易 (汇付Adapay通道)
$response = $client->post('/api/split/create', [
    'order_id'     => 'ORD202602230001',
    'total_amount' => 100.00,
    'channel'      => 'adapay',  // adapay | yeepay | baofoo
    'receivers'    => [
        ['account' => 'M001', 'amount' => 70.00],
        ['account' => 'P001', 'amount' => 30.00],
    ]
]);
IoT ACCESS CONTROL SDK

门禁物联 SDK

MQTT协议驱动的IoT设备管理平台,支持设备影子(Device Shadow)、OTA远程升级、连接管理、门店映射等核心能力。适配RK3308芯片、ML307R 4G模组等硬件。

REST API: https://mj.keduyunzhishou.com
MQTT Broker: 8.130.25.121:1883 | Topic: KD{设备ID}/entranceManage
MQTT协议设备影子OTA升级远程开门连接管理门店映射TTS语音蓝牙BLE

设备连接管理 API

GET/mqtt-connection-api.php?action=list

获取所有门禁设备连接信息,包含在线状态、IP地址、上下线时间、消息数。支持搜索和状态筛选。

pagepageSizesearchstatus
GET/mqtt-connection-api.php?action=statistics

获取设备统计:在线数、离线数、总设备数、在线率、今日上线数、累计消息数。

-
POST/mqtt-connection-api.php?action=update_status

更新设备连接状态,供MQTT服务器回调使用。设备上下线时自动调用。

client_idstatusip

设备影子 (Device Shadow) API

GET/device-shadow-api.php?action=list

获取设备影子列表,包含期望状态(desired)与实际状态(reported)的同步情况。

pagepageSize
GET/device-shadow-api.php?action=detail

获取单个设备影子详情,含desired/reported/delta三态数据。

device_id
POST/device-shadow-api.php?action=update_desired

更新设备期望状态,自动通过MQTT下发至设备端。用于远程配置门禁模式、音量等。

device_iddesired{}
POST/device-shadow-api.php?action=report

设备上报实际状态。终端设备定时或状态变更时调用,同步固件版本、传感器数据等。

device_idreported{}

OTA远程升级 API

GET/ota-api.php?action=firmware_list

获取固件版本列表,包含版本号、下载地址、文件大小、校验值等信息。

-
POST/ota-api.php?action=firmware_upload

上传新固件版本,支持设置版本号、下载URL、校验值和更新描述。

nameversionurlchecksum
POST/ota-api.php?action=create_task

创建OTA升级任务,指定固件版本和目标设备列表,通过MQTT下发升级指令。

firmware_iddevice_ids[]
POST/ota-api.php?action=report_progress

设备上报OTA升级进度,包含下载进度、安装状态、错误信息等。

task_iddevice_idprogressstatus

门店数据 API

GET/store-api.php?action=get

根据设备ID查询门店信息,返回门店名称、地址、在线状态。

client_id
GET/store-api.php?action=list

获取全部门店列表,含设备ID映射关系和在线状态。

-
GET/store-api.php?action=batch

批量获取门店信息,传入多个设备ID返回对应门店名称映射。

client_ids

MQTT协议规范

MQTT - 门禁控制协议
// MQTT Broker: 8.130.25.121:1883
// 主题格式: KD{设备ID}/entranceManage

// 1. 远程开门指令
Topic: KD00001/entranceManage
Payload: {"action":"open_door","mode":"remote","duration":5}

// 2. 设备状态上报
Topic: KD00001/status/report
Payload: {"firmware_version":"2.3.1","door_status":"closed","signal_4g":-65}

// 3. TTS语音播报
Topic: KD00001/tts
Payload: {"text":"欢迎光临","volume":80}

// 4. OTA升级下发
Topic: ota/device/KD00001/upgrade
Payload: {"action":"upgrade","version":"2.4.0","url":"https://..."}
REAL-TIME COMMUNICATION SDK

音视频通信 SDK

基于Java Spring Boot + Box-IM构建的实时通信系统,集成WebRTC音视频通话、IM即时消息、AI语音克隆(Python Flask)、TTS语音合成,为无人店提供远程客服能力。

IM API: https://ysp.keduyunzhishou.com:7460
WebSocket: wss://ysp.keduyunzhishou.com:5568 | Admin: :9434
WebRTC视频IM即时通讯AI语音克隆TTS语音合成群组通话AI智能应答

IM 即时通讯 API

POST/im/message/send

发送即时消息,支持文本、图片、语音、文件等多种消息类型。

from_idto_idtypecontent
GET/im/message/history

获取聊天记录,支持单聊和群聊历史消息分页查询。

session_idpagesize
POST/im/group/create

创建群组,用于门店客服群、区域运营群等场景。

namemember_ids[]type

WebRTC 音视频 API

POST/rtc/call/initiate

发起音视频通话,支持一对一和群组通话。用于客服远程查看门店收银机画面。

caller_idcallee_ids[]media_type
POST/rtc/call/answer

接听通话请求,返回WebRTC信令信息(SDP/ICE)。

call_idsdp

AI语音服务 API

POST/ai/voice/clone

声音克隆接口,上传音频样本训练专属声音模型。基于Python Flask + GPU加速。

audio_filespeaker_nameepochs
POST/ai/tts/synthesize

TTS语音合成,将文本转为语音。支持自定义声音模型、语速、音调。

textvoice_idspeedformat
POST/ai/chat/reply

AI智能应答接口,基于预设话术库自动回复顾客常见问题。

questioncontextstore_id
JavaScript - WebRTC通话示例
// 1. 建立WebSocket信令连接
const ws = new WebSocket('wss://ysp.keduyunzhishou.com:5568');

// 2. 发起视频通话
const pc = new RTCPeerConnection(config);
const stream = await navigator.mediaDevices.getUserMedia({video:true,audio:true});
stream.getTracks().forEach(t => pc.addTrack(t, stream));

const offer = await pc.createOffer();
await pc.setLocalDescription(offer);
ws.send(JSON.stringify({type:'call',callee:'store_001',sdp:offer}));
AI VISION SDK

AI视觉识别 SDK

基于深度学习的商品识别与人脸识别服务,Python Flask + GPU加速,支持14万+SKU商品秒级识别、ArcFace人脸识别、安全行为检测。

Base URL: https://kny.keduyunzhishou.com/vision
商品识别人脸识别安全检测行为分析GPU加速实时视频流

商品识别 API

POST/vision/product/recognize

商品图像识别,上传商品图片返回匹配商品信息。支持14万+SKU,识别延迟<500ms。

image (file/base64)top_kthreshold
POST/vision/product/train

商品模型训练,上传新商品图片增量训练识别模型,支持在线学习。

images[]goods_idgoods_name

人脸识别 API

POST/vision/face/register

人脸注册,上传人脸照片建立特征向量库。基于ArcFace算法,准确率99.2%+。

imageperson_idname
POST/vision/face/verify

1:1人脸验证,比对两张人脸是否为同一人。用于人脸支付、身份核验。

imageperson_id
POST/vision/face/search

1:N人脸搜索,在人脸库中检索匹配人员。用于VIP识别、黑名单告警。

imagegroup_idthreshold
POST/vision/safety/detect

安全行为检测,分析视频帧中的异常行为(偷盗、烟雾、跌倒等)。

imagedetect_types[]
Python - 商品识别调用示例
import requests

# 商品图像识别
url = "https://kny.keduyunzhishou.com/vision/product/recognize"
files = {"image": open("product.jpg", "rb")}
headers = {"Authorization": "Bearer your_api_key"}

resp = requests.post(url, files=files, headers=headers)
# {"code":200,"data":{"goods_id":1234,"name":"可口可乐330ml",
#   "confidence":0.97,"price":3.50,"barcode":"6901939621363"}}

# 人脸验证
face_url = "https://kny.keduyunzhishou.com/vision/face/verify"
resp = requests.post(face_url, files={"image": open("face.jpg","rb")},
    data={"person_id": "P001"}, headers=headers)
# {"code":200,"data":{"match":true,"similarity":0.95}}
CREDIT DEDUCTION SDK

信用代扣 SDK

基于Java若依(RuoYi)框架的信用代扣与团购业务平台,集成宝付支付通道,支持信用代扣签约、定时扣款、冻结解冻、团购订单管理等全链路能力。

Base URL: https://dk.keduyunzhishou.com/api
信用代扣定时扣款冻结解冻团购管理健身/宠物商户管理

代扣签约 API

POST/deduction/sign

发起信用代扣签约,用户授权后可进行定时扣款。集成宝付Baofoo支付通道。

user_idmerchant_idamountperiod
POST/deduction/execute

执行代扣操作,按签约协议从用户账户扣款。支持单次和批量扣款。

sign_idamountdescription
POST/deduction/freeze

冻结用户资金,用于预授权场景(棋牌室、健身房入场等)。

user_idamountreason
POST/deduction/unfreeze

解冻资金,支持全额解冻和部分扣除后解冻(实际消费金额扣除)。

freeze_iddeduct_amount

团购业务 API

GET/groupbuy/list

获取团购商品列表,支持按分类(健身、宠物、餐饮等)和区域筛选。

categorycitypage
POST/groupbuy/order/create

创建团购订单,支持在线支付和到店核销。

goods_idquantityuser_id
POST/groupbuy/order/verify

团购券核销,商家扫描用户核销码完成到店消费确认。

verify_codemerchant_id
GET/merchant/dashboard

商户数据看板,含销售额、订单量、核销率、用户增长等统计数据。

merchant_iddate_range
Java - 信用代扣签约示例
// 发起信用代扣签约 (宝付通道)
Map<String, Object> params = new HashMap<>();
params.put("user_id", "U10001");
params.put("merchant_id", "M2001");
params.put("amount", 199.00);
params.put("period", "monthly"); // daily|weekly|monthly

String resp = HttpUtil.post("https://dk.keduyunzhishou.com/api/deduction/sign", params);
// {"code":200,"data":{"sign_id":"SGN202602...","redirect_url":"..."}}
GROUP BUY SERVICE SDK

团购服务 SDK

本地生活团购平台API,消费者端+商家端双端支持,覆盖团购商品浏览、在线下单、到店核销、商家管理、营销推广等全链路团购业务。基于Java若依框架构建。

Base URL: https://dk.keduyunzhishou.com/api/groupbuy
团购商品在线下单到店核销商家管理健身团购宠物团购餐饮团购营销推广

团购商品 API

GET/groupbuy/goods/list

获取团购商品列表,支持按分类(健身、宠物、餐饮等)、区域、价格范围筛选,返回商品详情、库存、销量。

categorycityprice_minprice_maxpage
GET/groupbuy/goods/detail

获取团购商品详情,包含商品图片、规格、使用规则、可用门店、用户评价等完整信息。

goods_id
POST/groupbuy/goods/create

创建团购商品,设置价格、库存、有效期、使用规则、适用门店等信息。商家端使用。

titlepriceoriginal_pricestockexpire_days

团购订单 API

POST/groupbuy/order/create

创建团购订单,消费者选择商品和数量,支持在线支付。下单后生成核销码。

goods_idquantityuser_idpay_type
POST/groupbuy/order/verify

团购券核销,商家扫描消费者核销码完成到店消费确认。支持部分核销。

verify_codemerchant_id
GET/groupbuy/order/list

获取团购订单列表,支持按状态(待支付/待核销/已完成/已退款)筛选。

user_idstatuspage
POST/groupbuy/order/refund

团购订单退款,未核销的订单支持全额退款,已部分核销按剩余数量退款。

order_idreason
JavaScript - 团购下单示例
// 创建团购订单
const resp = await fetch('https://dk.keduyunzhishou.com/api/groupbuy/order/create', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer your_api_key', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    goods_id: 1001,
    quantity: 2,
    user_id: 'U10001',
    pay_type: 'wechat'
  })
});
// {"code":200,"data":{"order_id":"GB202602...","verify_code":"ABCD1234","pay_url":"..."}}
O2O SERVICE SDK

O2O上门服务 SDK

基于Spring Cloud微服务架构的上门服务O2O平台,16个微服务覆盖用户管理、技师调度、订单流转、支付结算、安全保障、营销推广等全链路能力。Java 17 + Spring Boot 3.2。

Gateway: https://api.konacloud.cn:8080
用户服务 :8081技师服务 :8082订单服务 :8083支付服务 :8084派单服务 :8085评价服务 :8086消息服务 :8087地图服务 :8088营销服务 :8089安全服务 :8090

用户 & 技师 API

POST/user/register

用户注册,支持手机号+验证码、微信授权登录。JWT鉴权 + Token黑名单。

phonesms_codewx_code
GET/technician/nearby

查询附近可用技师,基于地理位置排序,返回距离、评分、技能、空闲时段。

latlngservice_typeradius
GET/technician/profile

获取技师详情页,含资质认证、服务项目、评分评价、培训考核记录等。

technician_id

订单 & 派单 API

POST/order/create

创建上门服务订单,选择服务项目、时间、地址,系统自动匹配最优技师。

service_idaddressappointment_timetechnician_id
GET/dispatch/recommend

智能派单推荐,基于距离、评分、技能匹配度、历史服务等多维度智能排序。

order_idtop_n
POST/order/pay

订单支付接口,支持微信/支付宝/余额等多种支付方式。

order_idpay_type
POST/review/submit

提交服务评价,支持评分、文字评价、图片上传。

order_idscorecontentimages[]

安全保障 API

POST/safety/sos

SOS紧急求助,一键触发安全响应流程:GPS定位、录音取证、通知紧急联系人。

user_idorder_idlocation
POST/safety/face/verify

服务前人脸核验,确保上门技师身份真实。基于ArcFace算法。

technician_idimage

营销 & 积分 API

GET/marketing/activities

获取营销活动列表,包含优惠券、满减、新用户礼包等活动信息。

citytype
GET/points/balance

查询用户积分余额和积分明细记录。

user_id
Java - 微服务调用示例
// 通过Gateway统一入口调用
HttpHeaders headers = new HttpHeaders();
headers.setBearerAuth("your_jwt_token");

// 查询附近技师
String url = "https://api.konacloud.cn:8080/technician/nearby"
    + "?lat=31.23&lng=121.47&service_type=massage&radius=5000";
ResponseEntity<JsonNode> resp = restTemplate.exchange(
    url, HttpMethod.GET, new HttpEntity<>(headers), JsonNode.class);

// 创建订单
Map<String,Object> order = Map.of(
    "service_id", 101,
    "address", "上海市浦东新区...",
    "appointment_time", "2026-02-24 14:00");
restTemplate.postForEntity("https://api.konacloud.cn:8080/order/create",
    new HttpEntity<>(order, headers), JsonNode.class);
APP UPDATE API

应用检查更新 API

客户端App启动时调用此接口检查是否有新版本,支持强制更新标记。已在官网部署运行。

Base URL: https://www.konacloud.cn/api
GET/api/check_update.php

检查应用更新,返回是否有新版本、下载地址、更新日志、是否强制更新等信息。

app_key=merchant|cashier|groupbuyplatform=android|ios|windows|macoscurrent_version
cURL - 检查更新示例
curl -X GET "https://www.konacloud.cn/api/check_update.php?\
  app_key=merchant&platform=android&current_version=3.2.0"

# 响应示例
{
  "has_update": true,
  "force_update": false,
  "latest_version": "3.2.1",
  "download_url": "https://www.konacloud.cn/download/merchant_3.2.1.apk",
  "changelog": "1. 优化收银性能\n2. 新增人脸支付"
}

立即接入科纳云开放平台

获取API Key,开始构建您的智能门店应用