橙电科技零售柜套件开放平台
    橙电科技零售柜套件开放平台
    • 接入流程和鉴权
      • 获取访问令牌
        POST
    • 开放资源api
      • ping设备
        GET
      • 刷新设备硬件状态缓存
        GET
      • 获取设备硬件状态信息
        GET
      • 获取设备硬件信息
        GET
      • 检查设备是否可以开门
        GET
      • 下发指令操作设备开门
        POST
      • 设备开锁指令
        POST
      • 设置灯光
        POST
      • 设置设备音量
        POST
      • 设备重启系统
        POST
      • 重传订单视频文件
        POST
      • 设备风扇参数设置
        POST
      • 设备风扇操作
        POST
    • 事件回调通知
      • 接收事件回调通知 POST
        POST

    智能零售柜套件开放平台接⼊流程

    准备工作#

    1.
    准备 HWCDKJ-03 硬件套件
    2.
    联系管理员/商务，获取对应的appid和key
    3.
    Api访问地址为: https://ai.mjyun.com/v1/

    开放功能#

    1. AccessToken#

    AccessToken，即访问令牌。接口调用必备的公共参数之一，用于校验接口访问/调用是否有权限，有效期为7天，有效期内不需要重复申请（建议每2-3天更新一次），可以重复使用。

    目前平台支持仅支持Client Credentials Grant这一种OAuth授权方式获取AccessToken，使用appid和key访问服务端换取accessToken，其中appid和key在接入平台时我司会配置并提供给您。

    详情见获取访问令牌/auth/access_token/get接口#

    +---------+                                  +---------------+
|         |                                  |               |
|         |>--(A)- Client Authentication --->| Authorization |
| Client  |                                  |     Server    |
|         |<--(B)---- Access Token ---------<|               |
|         |                                  |               |
+---------+                                  +---------------+

    2. 设备信息获取#

    通过获取设备硬件状态信息的接口可以获取到当前设备的门锁状态、灯光亮度、摄像头工作状态、电池电量等等信息.
    获取设备硬件状态信息: /openapi/device/status/info

    默认状态下，会自动刷新；如果短时间内要多次刷新硬件状态，可以显示调用下面接口来强制刷新硬件状态（在线和离线状态会实时更新）#

    设备硬件状态信息缓存刷新: /openapi/device/statusInfo/refresh

    3. 操作设备#

    ping设备: /openapi/device/ping
    检查设备是否可以开门: /openapi/check/device/canOpen
    下单【设备开门】: /openapi/device/open
    音量设置: /openapi/device/volume
    风扇参数设置: /openapi/device/set/fan/params
    系统重启: /openapi/device/reboot
    订单视频重传: /openapi/device/reupload/video
    灯光亮度设置: /openapi/device/light
    设备开锁指令: /openapi/device/lock
    设备风扇操作: /openapi/device/fan/operate

    4. 下单流程#

    1.
    调用检查设备是否可以开门/openapi/check/device/canOpen检查设备是否可以开门；
    2.
    调用下单接口/openapi/device/open下单，下发指令使设备开门，该接口的返回成功与否并不代表设备门锁开启成功了，需要通过消息推送的"start_buy"类型的事件通知确定门锁已开；
    3.
    下单时默认是配置两个摄像头都开启录制并上传视频的，但如果某一个摄像头的视频并未上传，可以通过重传视频文件
    /openapi/device/reUpload/video接口重传订单视频。

    5. 事件回调通知#

    接入方式#

    目前仅支持http协议接入，采用 RESTful 风格，请求类型为POST，ContentType为application/json

    应用场景#

    设备上下线通知#

    用户将收到设备在线状态变更的实时通知

    设备开门订单流程通知#

    在通过下单【设备开门】/openapi/device/open接口操作设备开门之后，系统会对设备从开门到关门流程的每个步骤进行通知。

    详情见接收事件回调通知/callback接口#

    #

    附1-FAQ#

    1. 推荐与前端用户交互编程指南#

    1.1 设备在线状态#

    前端用户扫冰柜二维码码，打开小程序后，先调用获取设备硬件状态信息
     获取在线状态，如"onlineStatus"="online",
    主动调用一次 ping与设备通讯，确保真实在线。

    1.2 前端用户购物开门状态#

    用户执行下单指令后，实时监听事件回调通知事件汇总里的门锁状态，根据门锁状态的不同，在小程序中给用户相应的提示。
    image.png

    附2-错误码表#

    codemsg
    0成功
    -1失败，服务器响应异常
    10001参数错误
    10002appid不存在
    10003appid异常
    10004appid与key不匹配
    10005accessToken为空
    10006accessToken已过期
    20001设备不存在
    20002无权操作该设备
    20003关联的主板码为空
    20004设备网络异常
    20005设备离线
    20006设备操作指令有误
    20007设备灯光设置指令有误
    20008参数有误，不存在指定摄像头
    40001系统繁忙，请稍后重试
    40002请求超时，请重试
    修改于 2025-11-04 10:44:36
    下一页
    获取访问令牌
    Built with