客如云 API
新手指南
复制页面
客如云 API
平台简介
对接流程-API接口对接流程及操作步骤(不上架服务市场)
对接流程-API接口对接流程及操作步骤(上架服务市场)
认证指南-服务商认证
认证指南-品牌商认证
接口能力大图
https对接说明
接口请求公共参数
响应参数
V2签名规则
订单取消原因表
订单状态
错误码
订单配送状态
订单支付状态表
回调接口编码
支付机构代码
接收菜品分类变更通知
接收菜品变更通知
订单状态推送通知收费
自配送场景介绍
客如云下发配送通知
订单配送状态通知
优惠券核销通知接口-上行
第三方券核销介绍
登录成功回调收费
获取授权码code收费
新手指南
平台简介
对接流程-API接口对接流程及操作步骤(不上架服务市场)
对接流程-API接口对接流程及操作步骤(上架服务市场)
认证指南-服务商认证
认证指南-品牌商认证
接口能力大图
接口能力大图
公共说明
https对接说明
接口请求公共参数
响应参数
V2签名规则
附录
订单取消原因表
订单状态
错误码
订单配送状态
订单支付状态表
回调接口编码
支付机构代码
获取门店token
接口列表
门店信息
获取服务下可用门店
获取门店列表
获取门店信息
获取门店经营时间
查询门店营业状态
修改门店营业状态
查询桌台信息
附加费配置查询接口
支付类型查询
门店设备列表查询接口
门店设备状态推送接口
菜品
接收菜品分类变更通知
接收菜品变更通知
菜品分类信息查询
菜品父级信息查询
菜品分类查询
菜品分页查询
菜品精确查询
批量修改门店菜品售卖数量
订单信息
订单状态推送通知收费
查询订单详情
查询订单列表
后厨管理服务
后厨菜品制作状态变更推送
配送服务
自配送场景介绍
客如云下发配送通知
订单配送状态通知
商家自配送状态推送
会员1.0
会员基本信息1.0
创建顾客
创建/升级会员
查询会员实体卡列表
会员详情查询
修改会员详情
查询品牌下会员等级
修改会员等级信息
会员登录1.0
会员登录
会员登录二维码
获取免登录token
会员充值1.0
会员充值接口
查询门店储值消费金额
会员充值/消费记录查询
积分 1.0
会员积分增加
会员积分扣减
优惠券1.0
优惠券核销通知接口-上行
查询优惠券列表
查询券模板列表
查询优惠券详情
查询门店营销规则
券模板发券接口
客如云券核销
第三方券核销
第三方券核销介绍
券查询
券核销
券反核销
供应链1.0
供应链基础数据1.0
查询供应链物品接口
查询仓库列表
查询物品分类
查询供应链物品库存
查询商品库存收费
接收商品库存变更
查询供应商类别
查询供应商列表
查询交易记录
获取交易凭证
查询商户余额
采购单据1.0
查询采购入库单列表
查询采购订单收费
查询采购入库单明细
查询采购退货单明细
采购退货单列表收费
销售单据1.0
查询非销售单出库明细收费
库存单据1.0
入库单保存
入库详情查询
入库分页查询
收货单详情
收货单分页查询
调拨单详情查询
调拨单分页查询
出库单保存
出库详情查询
出库分页查询
配送签收单修改保存
查询配送签收单详情
配送签收单分页查询
退回单详情查询
退回单分页查询
退回入库单分页查询
退回入库单详情查询
盘点单详情查询
盘点单分页查询
报废单详情查询收费
报废单分页查询
支付收银服务
支付状态查询
扫码支付(主扫)
扫码支付(被扫)
退款状态查询
退款申请
OAUTH 授权服务
登录成功回调收费
获取授权码code收费
获取用户信息
获取token
新手指南
复制页面
对接流程-API接口对接流程及操作步骤(上架服务市场)
对接流程
#
开发者调用api接口开发产品功能,上架到客如云服务市场,售卖给客如云商户使用
## 操作步骤
1. 进入
开发者中心
#
2.注册登录
#
点击环境入口,注册成为开发者并登录开发者中心(正式环境和测试环境账号不一致,两个环境是分离的)
3.企业认证
#
申请企业认证-填写企业信息-提交审核
请根据实际情况选择入驻方式,申请须填写真实正确的企业信息,审核大概需要1-3个工作日
品牌商:商家自研或商家授权开发者在开放平台接入的服务,只提供给商家自有品牌使用。 服务商:行业解决方案商或软件服务商在开放平台接入的服务,可提供给客如云多品牌商户使用。
4.创建服务
#
新建服务-申请接口-提交审核
根据实际需求申请接口,一次性申请所有接口可能审核不通过,审核大概需要1-3个工作日
(1)点击新建
(2)申请接口
设置回调用地址要求: 开发者设置回调地址后,针对开发者设置的两条回调地址地址进行验证 第一个验证,会发送【开发者回调地址+?validate=success】这个请求给开发者,请求方式是post,开发者收到后需返回 { “code”: 0, “message”: “成功”, “messageUuid”: “3337b6f6-9c95-4992-9fd7-dd7e1e1fc453” }才可校验通过 第二个验证。会发送【开发者回调地址+?validate=fail】这个请求给开发者,请求方式是post,开发者收到后需返回 { “code”: -1, “message”: “失败”, “messageUuid”: “3337b6f6-9c95-4992-9fd7-dd7e1e1fc453” }才可校验通过
open API文档模块对应所需申请接口
(3)提交审核
(4)审核通过(可查看APPKEY,进行门店授权,取消发布后可重新编辑接口)
5.门店授权
#
点击授权二维码-截图给商户扫描授权
须把授权二维码提供给商户,商户授权同意才可使用
测试环境 (
https://gldsso.keruyun.com/sso-ui/#/login
?) 我们提供了三个测试用的门店ID供开发者调试接口使用,详细信息如下:
“brandId”: 601603 “commercialId”: 880010161 “commercialId”: 880010162 账户:15928515739 商家后台密码:kry888888 掌上客如云密码: 258369
线上环境 (
https://sso.keruyun.com/sso-ui/#/login
?) 我们提供了一个测试用的门店ID供开发者调试接口使用,详细信息如下: “brandId”: 32296 “shopid”: 810094162 账户:15132453544 商家后台密码:kry888888 掌上客如云密码: 258369
(1)点击授权二维码,截图给商户授权,商户使用
微信
扫码登录商家后台账号(
使用掌上客如云密码
)进行授权(测试环境自动通过)
注意: 【1】品牌与门店勾选无需开发者勾选,是根据接口授权的维度系统自动勾选,如果接口需要品牌授权,那么这里会自动勾选上品牌授权,如果需要门店授权,这里会自动勾选上门店授权。 【2】品牌与门店都勾选的,需要品牌与门店都授权
(2)门店授权完成,可获取token,该token值与通过接口获取的token值一样,通过token,就可以计算请求接口公共参数中的sign值,请求对应的接口数据
已经发布的服务中还需要添加接口,操作步骤如下:
取消发布-申请所需接口-提交审核—客如云审核通过—开发者提供升级授权二维码给商户扫码登录—点击服务升级按钮升级
注:新添加的接口必须要商户扫描升级二维码进入点击升级才可使用
6.上架到服务市场
#
在测试环境使用测试门店调试好服务功能,切换到正式环境,申请服务,点击入驻服务市场按钮进行服务上架操作,商户购买时才进行门店授权
(1)入驻服务市场
(2)登录市场管理中心,
此处账号与开发者中心账号一致
(3)点击上架服务
(4)填写基本信息,调用API接口,”关联客如云接口选项“选择“是”
(5)创建规格
(6)填写服务详情
(7)填写补充信息,申请上架
(8)服务创建完成(审核需要1-3个工作日)
【如客云】API开发者 微信交流群
用微信扫右侧二维码,加入【如客云】API开发者 交流群,互助沟通
扫码加入交流群
修改于
2021-12-16 06:36:25
上一页
对接流程-API接口对接流程及操作步骤(不上架服务市场)
下一页
认证指南-服务商认证