适用系统类型:ONPOS版,版本判断工具
适用软件版本:无限制
适用商家类型:有自主研发能力的餐饮品牌商户、有服务商支持的餐饮商户
注册成为开发者并登录开发者后台
新建服务-申请接口-提交审核 根据实际需求申请接口,一次性申请所有接口可能审核不通过,审核大概需要1-3个工作日
注意:
未入驻,则按照入驻要求先申请入驻。
品牌入驻
服务商入驻
(1)点击新建
(2)申请接口
服务名称填写要求: 服务名称在平台唯一,服务名称将会在服务授权时展示、pos上三方券核销入口展示、pos上三方配送入口展示,名称审核后不可修改,故请谨慎命名;
设置回调用地址要求: 开发者设置回调地址后,针对开发者设置的两个回调地址进行验证
第一个验证,会发送【开发者回调地址+?validate=success】这个请求给开发者,请求方式是post,开发者收到后需返回code、message、 messageUuid字段,且code=0, message=成功, messageUuid可自定义才可校验通过。例如: { “code”: 0, “message”: “成功”, “messageUuid”: “3337b6f6-9c95-4992-9fd7-dd7e1e1fc453” }
第二个验证。会发送【开发者回调地址+?validate=fail】这个请求给开发者,请求方式是post,开发者收到后需返回code、message、 messageUuid字段,且code=-1, message=失败, messageUuid可自定义才可校验通过。例如: { “code”: -1, “message”: “失败”, “messageUuid”: “3337b6f6-9c95-4992-9fd7-dd7e1e1fc453” }
open API文档模块对应所需申请接口。依据使用场景需要选择对应的接口,点击对应接口模块的“申请接口”;客如云开放平台接口以整体模块化申请。例如选择申请订单信息接口,则包含开放文档中对应的订单列表,订单详情及订单状态三个接口。
(3)提交审核
(4)审核通过(可查看APPKEY,进行门店授权,取消发布后可重新编辑接口)
点击授权二维码-截图给商户扫描授权
须把授权二维码提供给商户,商户授权同意才可使用
线上环境 (https://sso.keruyun.com/sso-ui/#/login?) 我们提供了一个测试用的门店ID供开发者调试接口使用,详细信息如下: “brandId”: 32296 “shopid”: 810094162 账户:15132453544 商家后台密码:kry888888 掌上客如云密码: 258369
(1)点击授权二维码,截图给商户授权,商户使用微信扫码登录商家后台账号(使用掌上客如云密码)进行授权
注意: 【1】品牌与门店勾选无需开发者勾选,是根据接口授权的维度系统自动勾选,如果接口需要品牌授权,那么这里会自动勾选上品牌授权,如果需要门店授权,这里会自动勾选上门店授权。 【2】品牌与门店都勾选的,需要品牌与门店都授权
(2)门店授权完成,可获取token,该token值与通过接口获取的token值一样,通过token,就可以计算请求接口公共参数中的sign值,请求对应的接口数据
已经发布的服务中还需要添加接口,操作步骤如下:
取消发布-申请所需接口-提交审核—客如云审核通过—开发者提供升级授权二维码给商户扫码登录—点击服务升级按钮升级
注:新添加的接口必须要商户扫描升级二维码进入点击升级才可使用