• 开发者平台
  • >
  • 餐饮文档中心

API接口对接流程及操作步骤(不上架服务市场)


对接流程

开发者调用api接口为指定商户开发定制化功能,无需上架到客如云服务市场售卖 不上架到服务市场流程图


操作步骤

1. 进入 开发者后台


image.png

2.注册登录

点击环境入口,注册成为开发者并登录开发者后台

image.png

3.企业认证

申请企业认证-填写企业信息-提交审核 请根据实际情况选择入驻方式,申请须填写真实正确的企业信息,审核大概需要1-3个工作日 品牌商:商家自研或商家授权开发者在开放平台接入的服务,只提供给商家自有品牌使用。 服务商:行业解决方案商或软件服务商在开放平台接入的服务,可提供给客如云多品牌商户使用。

image.png

4.创建服务

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

15.png
(2)申请接口

16.png
设置回调用地址要求: 开发者设置回调地址后,针对开发者设置的两条回调地址地址进行验证 第一个验证,会发送【开发者回调地址+?validate=success】这个请求给开发者,请求方式是post,开发者收到后需返回 { “code”: 0, “message”: “成功”, “messageUuid”: “3337b6f6-9c95-4992-9fd7-dd7e1e1fc453” }才可校验通过 第二个验证。会发送【开发者回调地址+?validate=fail】这个请求给开发者,请求方式是post,开发者收到后需返回 { “code”: -1, “message”: “失败”, “messageUuid”: “3337b6f6-9c95-4992-9fd7-dd7e1e1fc453” }才可校验通过 image.png

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

image.png

(3)提交审核

image.png



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

19.png

5.门店授权

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

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

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

“brandId”: 601603 “shopid”: 880010161 “shopid”: 880010162 账户:15928515739 商家后台密码:kry888888 掌上客如云密码: 258369

线上环境 (https://sso.keruyun.com/sso-ui/#/login?) 我们提供了一个测试用的门店ID供开发者调试接口使用,详细信息如下: “brandId”: 32296 “shopid”: 810094162 账户:15132453544 商家后台密码:kry888888 掌上客如云密码: 258369

(1)点击授权二维码,截图给商户授权,商户使用微信扫码登录商家后台账号(使用掌上客如云密码)进行授权(测试环境自动通过)

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

20.png


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

21.png


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

33.png

6.技术咨询

方式一:不加群,提报问题工单(面向非开发人员)

浏览器打开工单地址填写: https://www.aliwork.com/o/GDTXB 或使用钉钉扫一扫二维码提报: 客如云开放平台工单系统.jpeg

方式二:加入技术支持群 (仅限开发岗加入)

钉钉搜索群号“31383957”(客如云API技术支持群-仅限开发入群)

进群的正确方式:请按照**"公司名称-在司岗位"格式****填写公司名称,在司岗位。【仅限研发(RD)人员申请加入,请按规则备注申请进群,未按规定备注将会被拒绝。】
目录