开发者后台

  • 开发者平台
  • >
  • 餐饮文档中心
    API开发文档
  • 1 开发指南
  • 2 平台介绍及入驻指南
    • 2.1 平台简介
    • 2.2 认证指南
      • 2.2.1 服务商认证
      • 2.2.2 品牌商认证
    • 2.3 对接流程
      • 2.3.1 API接口对接流程（不上架服务市场）
      • 2.3.2 API接口对接流程（上架服务市场）
  • 3 公共说明
    • 3.1 https对接说明
    • 3.2 请求公共参数
    • 3.3 获取门店token
    • 3.4 签名规则
    • 3.5 调试工具
      • 3.5.1 2.0签名生成工具
    • 3.6 响应参数
    • 3.7 附录
      • 3.7.1 订单状态
      • 3.7.2 错误码
      • 3.7.3 订单取消原因表
      • 3.7.4 订单支付状态表
      • 3.7.5 订单配送状态
      • 3.7.6 回调接口编码
      • 3.7.7 支付机构代码
  • 4 餐饮系统
    • 4.1 接口能力大图
    • 4.2 接口列表
      • 4.2.1 门店信息
        • 4.2.1.1 获取门店列表
        • 4.2.1.2 获取门店信息
        • 4.2.1.3 查询桌台信息
        • 4.2.1.4 获取门店经营时间
        • 4.2.1.5 获取服务下可用门店
        • 4.2.1.6 查询门店营业状态
        • 4.2.1.7 修改门店营业状态
        • 4.2.1.8 支付类型查询
        • 4.2.1.9 附加费配置查询接口
        • 4.2.1.10 门店设备列表查询接口
        • 4.2.1.11 门店设备状态推送接口
      • 4.2.2 菜品
        • 4.2.2.1 菜品分类信息查询
        • 4.2.2.2 菜品父级信息查询
        • 4.2.2.3 菜品分页查询
        • 4.2.2.4 菜品精确查询
        • 4.2.2.5 菜品分类查询
        • 4.2.2.6 接收菜品变更通知
        • 4.2.2.7 接收菜品分类变更通知
        • 4.2.2.8 批量修改门店菜品售卖数量
      • 4.2.3 订单信息
        • 4.2.3.1 查询订单详情
        • 4.2.3.2 订单状态推送通知
      • 4.2.4 外卖
        • 4.2.4.1 场景流程与介绍
        • 4.2.4.2 外卖下单服务
          • 4.2.4.2.1 外卖下单
          • 4.2.4.2.2 订单状态查询
          • 4.2.4.2.3 客如云接收订单通知
          • 4.2.4.2.4 客如云拒绝订单通知
          • 4.2.4.2.5 合作方取消订单
          • 4.2.4.2.6 客如云推送配送状态
          • 4.2.4.2.7 合作方推送配送状态通知
          • 4.2.4.2.8 合作方申请退款
          • 4.2.4.2.9 商家同意退款通知
          • 4.2.4.2.10 商家拒绝退款通知
          • 4.2.4.2.11 合作方退款成功通知
          • 4.2.4.2.12 商户作废订单通知
          • 4.2.4.2.13 客如云退货通知
      • 4.2.5 后厨管理服务
      • 4.2.6 配送服务
        • 4.2.6.1 客如云下发配送通知
        • 4.2.6.2 订单配送状态通知
        • 4.2.6.3 商家自配送状态推送
      • 4.2.7 会员
        • 4.2.7.1 会员基本信息
          • 4.2.7.1.1 创建顾客
          • 4.2.7.1.2 创建/升级会员
          • 4.2.7.1.3 会员详情查询
          • 4.2.7.1.4 修改会员详情
          • 4.2.7.1.5 查询会员实体卡列表
          • 4.2.7.1.6 查询品牌下会员等级
          • 4.2.7.1.7 修改会员等级信息
        • 4.2.7.2 会员登录
          • 4.2.7.2.1 会员登录
          • 4.2.7.2.2 获取免登录token
          • 4.2.7.2.3 会员登录二维码
        • 4.2.7.3 会员充值
          • 4.2.7.3.1 会员充值/消费记录查询
          • 4.2.7.3.2 会员充值接口
          • 4.2.7.3.3 查询门店储值消费金额
      • 4.2.8 积分
        • 4.2.8.1 会员积分增加
        • 4.2.8.2 会员积分扣减
      • 4.2.9 优惠券
        • 4.2.9.1 查询优惠券列表
        • 4.2.9.2 查询优惠券详情
        • 4.2.9.3 查询券模板列表
        • 4.2.9.4 券模板发券接口
        • 4.2.9.5 客如云券核销
        • 4.2.9.6 查询门店营销规则
      • 4.2.10 第三方券核销
        • 4.2.10.1 第三方券核销场景与流程介绍
        • 4.2.10.2 券查询
        • 4.2.10.3 券核销
        • 4.2.10.4 券反核销
      • 4.2.11 供应链
        • 4.2.11.1 供应链基础数据
          • 4.2.11.1.1 获取交易凭证
          • 4.2.11.1.2 查询供应链物品库存
          • 4.2.11.1.3 查询商户余额
          • 4.2.11.1.4 查询商品库存
          • 4.2.11.1.5 查询仓库列表
          • 4.2.11.1.6 查询供应商类别
          • 4.2.11.1.7 查询供应商列表
          • 4.2.11.1.8 查询供应链物品接口
          • 4.2.11.1.9 查询物品分类
          • 4.2.11.1.10 接收商品库存变更
          • 4.2.11.1.11 查询交易记录
        • 4.2.11.2 销售单据
        • 4.2.11.3 采购单据
          • 4.2.11.3.1 查询采购入库单列表
          • 4.2.11.3.2 查询采购入库单明细
          • 4.2.11.3.3 查询采购订单
          • 4.2.11.3.4 采购退货单列表
          • 4.2.11.3.5 查询采购退货单明细
        • 4.2.11.4 库存单据
          • 4.2.11.4.1 入库分页查询
          • 4.2.11.4.2 入库详情查询
          • 4.2.11.4.3 出库分页查询
          • 4.2.11.4.4 出库详情查询
          • 4.2.11.4.5 调拨单分页查询
          • 4.2.11.4.6 调拨单详情查询
          • 4.2.11.4.7 盘点单分页查询
          • 4.2.11.4.8 盘点单详情查询
          • 4.2.11.4.9 退回单分页查询
          • 4.2.11.4.10 退回单详情查询
          • 4.2.11.4.11 出库单保存
          • 4.2.11.4.12 入库单保存
          • 4.2.11.4.13 收货单分页查询
          • 4.2.11.4.14 收货单详情
          • 4.2.11.4.15 报废单分页查询
          • 4.2.11.4.16 报废单详情查询
          • 4.2.11.4.17 配送签收单分页查询
          • 4.2.11.4.18 查询配送签收单详情
          • 4.2.11.4.19 退回入库单详情查询
          • 4.2.11.4.20 退回入库单分页查询
          • 4.2.11.4.21 配送签收单修改保存
      • 4.2.12 支付收银服务
        • 4.2.12.1 扫码支付（主扫）
        • 4.2.12.2 扫码支付（被扫）
        • 4.2.12.3 支付状态查询
        • 4.2.12.4 退款申请
        • 4.2.12.5 退款状态查询
      • 4.2.13 OAUTH授权服务
        • 4.2.13.1 获取授权码code
        • 4.2.13.2 登录成功回调
        • 4.2.13.3 获取token
        • 4.2.13.4 获取用户信息
    • 4.3 常见FAQ
  • 5 服务市场入驻
    • 5.1 不调用API接口，直接把服务上架到服务市场
    • 5.2 服务市场事件通知
  • 6 开放平台公告
    • 6.1 【公告】开放平台服务协议更新公告
  • 7 更新日志

API接口对接流程（不上架服务市场）

1. 进入 开发者中心


13.png

2.注册登录

点击环境入口，注册成为开发者并登录开发者中心（正式环境和测试环境账号不一致，两个环境是分离的）



3.企业认证

申请企业认证-填写企业信息-提交审核 申请须填写真实正确的企业信息，审核大概需要1-3个工作日
(1)申请企业认证



(2)填写并提交企业信息

14.png
(3)认证成功


4.创建服务

新建服务-申请接口-提交审核 根据实际需求申请接口，一次性申请所有接口可能审核不通过,审核大概需要1-3个工作日
(1)点击新建

15.png
(2)申请接口

16.png
open API文档模块对应所需申请接口

17.png
(3)提交审核

18.png

(4)审核通过（可查看APPKEY，进行门店授权，取消发布后可重新编辑接口）

19.png

5.门店授权

点击授权二维码-截图给商户扫描授权

须把授权二维码提供给商户，商户授权同意才可使用

测试环境 (https://gldsso.keruyun.com/sso-ui/#/login?) 我们提供了三个测试用的门店ID供开发者调试接口使用，详细信息如下：

810094162、810097768、810097769

测试专用的商户管理后台账号(测试环境)： 品牌ID：32296 用户名：15132453544 密码：kry888888

(1)点击授权二维码，截图给商户授权，商户使用微信扫码登录商家后台账号进行授权（测试环境自动通过）

注意： 【1】品牌与门店无需开发者勾选，是根据接口授权的维度系统自动勾选，如果接口需要品牌授权，那么这里会自动勾选上品牌授权，如果需要门店授权，这里会自动勾选上门店授权。 【2】品牌与门店都勾选的，需要品牌与门店都授权

20.png


（2）门店授权完成，可获取token，该token值与通过接口获取的token值一样，通过token，就可以计算请求接口公共参数中的sign值，请求对应的接口数据

21.png


已经发布的服务中还需要添加接口，操作步骤如下：
取消发布-申请所需接口-提交审核—客如云审核通过—开发者提供升级授权二维码给商户扫码登录———点击服务升级按钮升级 注：新添加的接口必须要商户扫描升级二维码进入点击升级才可使用

33.png

6.技术咨询

请加客如云openAPI技术沟通钉钉群：31383957

进群的正确方式：请按照"公司名称-RD/PM-昵称"格式填写公司名称，岗位，昵称。【仅限合作方产品（PM）研发（RD）人员申请加入，请按设置的问题回复申请进群】

22.png

目录