二维火OpenAPI

二维火OpenAPI是提供给广大商户的一种技术接入方式。

使用OpenAPI可以实现统一的餐厅和菜单管理、订单生成和查询等操作。

如有任何对接疑问，请发邮件至 open.service@2dfire.com 。

二维火开放平台QQ交流群： 140188907 (1群已满), 791487614 (2群)

访问地址：http://open.2dfire.com

测试地址：http://open.2dfire-daily.com/router

正式地址：http://open.2dfire.com/router

注解

此版本为初稿，仅供参考。不做任何保证。

应以正式对接开始后的版本为准。

对接流程

1、单店及连锁对接

2、开发者对接

• 整体架构
• 总体规范
  • 总体概述
  • 规范约定
  • 全局参数
  • 返回数据格式
• 店铺数据
  • 接口说明
  • 接口定义
    • 1、查询绑定店铺列表
    • 2、根据连锁店铺ID获取品牌信息
    • 3、查询商铺的单个菜品信息
    • 4、查询商铺所有的菜品信息
    • 5、查询店铺经营执照信息
    • 6、查询店铺实体运营信息
    • 7、查询店铺法人联系信息
• 营业数据
  • 接口说明
  • 接口定义
    • 1、订单数据统计报表（按天）
    • 2、订单数据统计报表（按月）
    • 3、订单来源统计报表（按天）
    • 4、订单来源统计报表（按月）
    • 5、订单支付统计报表（按天）
    • 6、订单支付统计报表（按月）
    • 7、点菜数据统计报表（按天）
    • 7、点菜数据统计报表（按月）
• 订单数据
  • 接口说明
  • 接口定义
    • 1、查询店铺订单列表
    • 2、查询店铺订单详情列表
    • 3、订单排队消息推送
    • 4、查询店铺支付流水
    • 5、零售订单列表
    • 6、零售退货订单列表
• 会员数据
  • 接口说明
  • 接口定义
    • 1、查询会员卡信息列表
    • 2、查询会员金额流水记录(按天)
    • 3、查询会员积分流水记录（按天）
    • 4、查询会员操作流水记录（按天）
    • 5、保存会员信息
    • 6、会员卡充值
    • 7、会员卡支付
    • 8、会员卡红冲
    • 9、更新会员卡状态
    • 10、会员消息推送（POST）
    • 11、查询会员卡脱敏信息列表
• 优惠券数据
  • 接口说明
  • 接口定义
    • 1、获取优惠券列表信息
    • 2、发放优惠券
    • 3、查询用户优惠券
    • 4、保存优惠券信息
    • 5、第三方优惠券核销
    • 6、删除优惠券
    • 7、转增优惠券
    • 8、删除用户优惠券
    • 9、核销优惠券消息推送（POST）
• 供应链数据
  • 接口说明
  • 接口定义
    • 1、查询供应商列表
    • 2、查询原料信息列表
    • 3、查询店铺采购单信息列表
    • 4、查询店铺配送单信息列表
    • 5、查询店铺入库单信息列表
    • 6、查询店铺退货单信息列表
    • 7、查询店铺仓库间调拨单列表
    • 8、查询店铺库存调整单列表
    • 9、查询店铺仓库盘存单列表
    • 10、查询店铺加工单列表
    • 11、查询店铺库存列表
    • 12、查询店铺仓库列表
    • 13、POS销售订单提交
• 商户贷款
  • 相关流程
  • 接口定义
    • 1.1 贷款相关接口
    • 2.2 贷款状态变更接口
    • 2.3 取营业数据接口
    • 2.4 付款方式统计数据查询接口
    • 2.5 时段统计数据查询接口
    • 2.6 贷款商户敏感信息查询接口
    • 2.7 贷款商户银行信息查询接口
• 外卖开放接口
  • 背景介绍
  • 相关流程
  • 接口定义
    • 0.菜类菜品及菜品沽清状态变更消息推送
    • 1.菜类
      • 1.1单个菜类查询
      • 1.2批量菜类查询
    • 2.菜品
      • 2.1单个菜品查询
      • 2.2批量菜品查询
    • 3.订单
      • 3.1下单
      • 3.2查看订单是否下单成功
      • 3.3取消订单
      • 3.4配送状态变更
      • 3.5商家撤销、审核订单消息回推
    • 4.订单2.0
      • 4.1 下单(支持套餐)
• 配送开放接口
  • 配送状态机
  • 接口定义
    • 1.下发配送订单流程
    • 2.接收第三方配送平台推送过来的配送订单状态
    • 3.商家取消本店外卖配送订单
• 调用实例
  • Java实现
    • 1、RestTemplate 请求方式
    • 2、HttpClient 请求方式
    • 3、SDK 请求方式
    • 4、加密部分
    • 5、签名部分
    • 6、三方收到二维火发出的消息，返回接收信息成功
  • PHP实现
  • C#实现
    • 1、请求方式
    • 2、签名部分
• 错误编码
  • 1、系统错误码
  • 2、业务错误码