客如云 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

    V2签名规则

    1.加密步骤#

    1.
    公共参数(除去sign)按照参数名ASCII码进行自然排序,然后按照k1v1k2v2…拼接,结果为parameters;
    2.
    拼接parameters+body+token;
    3.
    将所得字符串进行SHA-256运算,返回即为sign的值。
    排序后再组装参数字符串,将body(为空则不加)和客如云提供的token放在排序字符串的后面,对新组装的参数字符串进行SHA-256加密生成sign字符串。生成的sign参数放到请求接口参数后面当成普通参数即可,参数名为sign

    2.sign值加密规则#

    加密规则#

    sign=SHA256(appKey+shopIdenty/brandId+timestamp+version+body+token)
    注意: sign一定要按顺序拼接字段 shopIdenty 和 brandId 只传其中一个。 品牌授权传brandId ,门店授权传 shopIdenty。

    2.1 门店授权接口sign值加密规则示例#

    {
      appKey:7857ca1808d370e2501290bc853eecdc
      shopIdenty:810094162
      timestamp:1528683797798
      version:2.0
      body:{"aaa":1}
      token:66e53b22f1496d183e71b4ab90f4acf7
    }
       sign=SHA256(appKey7857ca1808d370e2501290bc853eecdcshopIdenty810094162timestamp1528683797798version2.0body{"aaa":1}66e53b22f1496d183e71b4ab90f4acf7)
    version传固定值2.0
    参数拼接并排序 appKey301001shopIdenty247900001timestamp1425635264version2.0body{body}{TOKEN} 注意:【body值直接跟在version2.0后面】

    2.2 品牌授权接口sign加密规则示例#

    {
      appKey:7857ca1808d370e2501290bc853eecdc
      brandId:32296
      timestamp:1528683797798
      version:2.0
      token:66e53b22f1496d183e71b4ab90f4acf7
      body:{"aaa":1}
    }
       sign=SHA256(appKey7857ca1808d370e2501290bc853eecdcbrandId32296timestamp1528683797798version2.0body{"aaa":1}66e53b22f1496d183e71b4ab90f4acf7)

    3.签名规则描述示例#

    (1)公共参数#

    请求公共参数:
    https://openapi.keruyun.com/open/v1/signTest?appKey=301001&shopIdenty=247900001&version=2.0&timestamp=1425635264&sign
    请求body体:
    request body: {"aaa":1}
    通过SHA256运算得到签名sign sign=SHA256(appKey301001shopIdenty247900001timestamp1425635264version2.0body{“aaa”:1}66e53b22f1496d183e71b4ab90f4acf7)
    如上计算完成签名之后,把sign结果放到URL参数里面:
    /open/v2/signTest?appKey=301001&shopIdenty=247900001&version=2.0&timestamp=1425635264&sign=779d704132837f6fd93178a0eff9e70ce8e365321cb5874708a05bad96a44887

    (2)业务参数#

    {
    "aaa":1
    }

    4.代码示例#

    【如客云】API开发者 微信交流群

    用微信扫右侧二维码,加入【如客云】API开发者 交流群,互助沟通

    扫码加入交流群
    上一页
    响应参数
    下一页
    订单取消原因表
    Built with