适用客户: 已使用客如云收银系统的商户或需要获取商户在客如云收银系统产生的数据的监管平台,希望获取门店营业数据,在第三方BI系统或自研的BI系统或监管平台数据中台进行数据分析;
业务场景: 门店营业分析、营销活动分析、会员数据分析、业务预警等;
解决方案: 基于客如云提供的营业数据、菜品信息、门店信息、会员1.0等标准接口,开发者可获取商户在固定时间内的营业数据,转化为监管部门所需数据;第三方数据中台/BI系统完成数据加工,基于决策分析模型生成管理决策效果展示。
1.监管平台数据中台对接
2.第三方或自研数据中台/BI系统对接
方式一:购买已对接服务 服务市场入口 方式二:自研对接流程 1.开发者入驻
请根据开放平台服务商、品牌商入驻说明进行入驻:入驻说明
入驻用户类型 | 入驻用户说明 |
---|---|
品牌商 | 有自主研发能力的品牌,且通过开放平台对接的应用不可提供给其它品牌使用的品牌商户统称为品牌商 |
服务商 | 为第三方平台及众多餐商户提供应用系统、信息传递方式以及信息管理方式的开发者主体统称为服务商,服务品牌数大于1个的开发者主体,且有独立的技术团队,例如:erp系统、供应链系统、集成平台。服务商入驻开放平台需提供服务商信息安全资质 |
2.申请服务包: 根据对接流程申请服务包, 本方案推荐的服务包:订单信息模块、门店信息模块、菜品模块
3.门店授权: 根据对接流程进行门店授权
4.接口调试: 按照接口文档进行业务功能设计
接口模块 | 接口使用说明 |
---|---|
订单信息 | 1.用途:拉取门店店内营业相关的订单明细数据;2.调用顺序:(1)通过订单列表获取订单ID,通过订单ID获取订单详情。(2)可接入订单消息推送,实时获取订单最新数据,根据推送的订单ID,通过订单ID获取订单详情。 |
门店基础信息 | 1.用途:拉取门店组织机构信息,在第三方BI系统完成组织机构映射;2.调用顺序:(1)通过门店列表接口获取门店ID,根据门店ID获取门店详情 |
菜品 | 1.用途:拉取菜品信息,在第三方BI系统完成菜品映射;调用顺序:(1)通过菜品分类接口查询菜品分类ID,根据菜品分类ID获取菜品分类详情;(2)通过门店分页查询获取门店菜品ID,根据菜品ID获取菜品详情; |
5.联调上线: 接口对接完成,可直接投入使用
接口分类 | 接口详情 | 接口说明 |
---|---|---|
订单信息类 | 订单列表 | 可根据营业时间、订单支付时间获取订单信息 |
订单信息类 | 订单详情 | 可获取订单支付信息、菜品信息、优惠信息、会员信息 |
订单信息类 | 订单状态推送 | 可实时获取新产生的订单ID,通过订单ID可查询订单详情 |
商户基础类(非必接) | 获取门店列表 | 可获取品牌下所有门店信息 |
商户基础类(非必接) | 获取门店信息 | 可获取制定门店信息包括门店品牌信息、基础信息、营业时间信息 |
菜品信息类(非必接) | 菜品分页查询 | 可分页获取门店菜品信息 |
菜品信息类(非必接) | 菜品精确查询 | 可通过门店ID获取门店精确信息 |
菜品信息类(非必接) | 菜品分类ID查询 | 可查询菜品分类ID以及分类名称信息 |
菜品信息类(非必接) | 菜品分类信息查询 | 可查询菜品分类ID以及分类名称信息 |
1.接口收费么?
A:目前客如云接口暂不收费,但不承诺永久免费,如有收费会将收费规则及收费价格政策等在开放平台网站公示。
2.能导出超过7天的订单数据吗?
A:目前接口侧仅支持导出最近7天的数据,暂不支持接口获取超过7天的数据,开发者可以联系商户登录客如云商家管理后台导出最近两年内的数据进行加工处理。
3.商户有一个数据中台可以协助对接么?
A:请参考财务连接器–监管平台版的内容咨询开发者是否满足需求,如不满足需求需要自行开发,客如云开放平台暂不提供对接服务。
4.对接过程,如果有问题怎么处理?
A:钉钉搜索群号“31383957”(客如云API技术支持群-仅限开发入群) 进群的正确方式:请按照**"公司名称-在司岗位"格式****填写公司名称,在司岗位。【仅限合作方产品(PM)研发(RD)人员申请加入,请按规则设置申请进群】