云+物娱/网络摄像头方案娃娃机接入文档

奇艺果网络摄像头方案娃娃机接入文档

时序图

输入图片说明

一些准备工作

申请娃娃机管理后台账号密码。
申请接口接入平台idflatform、密匙secret用于生成签名sign。
申请测试娃娃机。
提供拉流服务器，建立视频推流，添加摄像头到设备管理后台。（网络摄像头为rtmp协议，仅支持app）。

奇艺果后台接口签名算法

生成规则：

a.声明参数对应的关联数组，然后将数组按key ASCII编码进行升序排序。
b.将排序好的数字按key.value拼接成一个字符串，对拼接的字符串进行md5加密
c.将加密后的得到的字符串再次和约定好的密钥进行拼接，然后再次md5加密，最终得到签名. 参考代码如下：（注：$data为除sign,app,act之外的所有请求参数，含POST、GET参数）

   /**
     * 生成sign 算法
     * 
     * @return string
     */
    public function sign(){

        //第三方密钥
        $platform_secret = 'testsecret';

        //请求参数 列表接口
        $params =[
            'platform' => 'platform_id', //平台id
            'page' => 1,
            'per_page' => 20,
            'ts' => time(),
        ];

        //数组排序
        ksort($params);
        $string = '';
        foreach ($params as $key => $value) {
            //字符串链接
            $string .= $key . $value;
        }
        //生成字符串  string = 'page1per_page20platformplatform_idts1518407130';
        $str = md5(md5($string) . $platform_secret);
        return $str;
    }

获取娃娃机列表接口

{site_url}/api/index.php?app=doll&act=doll_list
请求方法：HTTP GET

请求参数	说明	值
platform	平台方	如：qyguo
page	页码	默认：1
per_page	每页设备数量	默认：20

应答包：
{
    "done": true, //是否成功
    "msg": "",
    "retval": {
        "list": [{
             "device_id":"",                                             //设备id
             "status": "0",                                              //设备状态
             "name": "设备A0058",                                        //设备名称
             "img": ",                                                  //设备图片
             "stream_address_1": "rtmp:",                               //正面视频地址         
             "stream_address_2": "rtmp:",                               //侧面视频地址
             "stream_address_raw_1": "rtsp:",                           //正面原始视频流
             "stream_address_raw_2": "rtsp:"                            //侧面原始视频流
             "goods_id": "1711209579",                                  //商品ID
             "goods_name": "9寸微笑熊",                                   //商品名称
             "stock": "22",
             "is_top"                                                       //是否有顶部摄像头1：是 0：否
         },],
        "per_page": "3",
        "page": 2,
        "total_count": 58
}

申请分配娃娃机接口（开始游戏）

请求URL：{site_url}/api/index.php?app=doll&act=assign
请求方式：GET

请求参数	说明	值
device_id	设备id	如：kZFui5UaYHGfkPNBauvq3C
user_id	用户id是唯一的	如：420808
platform	平台方	如：qyguo
config	游戏参数设置 power_grab 强抓力 0-100 弱抓力 0-100 非必需	如：{"power_grab":90,"power_up":90}

应答包：  
{
    "done": true,                                                        //Bool true:成功 false:失败
    "msg": "操作成功",                                                    //结果信息
    "retval": {
        "log_id": 51508,                                                 //操作日志id
        "time": 20,                                                      //游戏时间
        "device_id": "ScmAJt8zdiXvXYLHowWpAP",                           //设备id
        "ws_url": "ws://doll.artqiyi.dev:9502?device_id=ScmAJt8zdiXvXYLHowWpAP&user_id=1&platform=qyguo&ts=&sign="
        //  用于websocket方式操作娃娃机                      
    }
}

操控娃娃机接口

请求URL：{site_url}/api/index.php?app=doll&act=operate
请求方式：GET
前置条件：先分配设备且在游戏时间内才可以操作(不用sign校验)

请求参数	说明	值
device_id	设备id	如：kZFui5UaYHGfkPNBauvq3C
action	娃娃机操作	1-前进，2-后退，3,-左移，4-右移，5-抓取娃娃 6-前进终止，7-后退终止，8-左移终止，9-右移终止
user_id	用户id是唯一的	如：420808
platform	平台方	如：qyguo

应答包：  
{
    "done": true,                                  //Bool true:成功 false:失败
    "msg": "操作成功",                              //
    "retval": []
}

查询操作结果

请求URL：{site_url}/api/index.php?app=doll&act=operate_result
请求方式：GET 备注：(平台有地址管理就不用收货信息 address consignee mobile )

请求参数	说明	值
platform	平台方	如：qyguo
log_id	操作记录ID	如：23

应答包：  
{
    "done": true,                                    //Bool true:成功 false:失败
    "msg": "",              
    "retval": {
        "user_id": "420808",                        //用户id
        "device_id": "AfyThD7bQmqtVayXcCfP2a",      //设备id
        "operate_result": "1",                      //0:失败没有操作1:成功
        "platform": "qyguo",                        //平台ID
        "add_time": "1510142851",                   //时间
        "consignee": "",                            //收货人
        "address": "",                              //地址
        "mobile": "",                               //收货人电话
        "goods_id": "1711022117"                    //商品id
    }
}

查询设备状态

请求URL：{site_url}/api/index.php?app=doll&act=get_device_status
请求方式：GET

请求参数	说明	值
platform	平台方	如：qyguo
device_id	设备id	如：KVA8mV94Vr2R3hrkxK

应答包：  
{
    "done": true,
    "msg": "",
    "retval": {
        "device_id": "KVA8mV94Vr2R3hrkxK",                                 //设备id                                  
        "status": "0",                                                     //0:空闲 1:游戏中
        "stream_address_1": "1",                                           //正面视频地址
        "stream_address_2": "1"，                                          //侧面视频地址
        "stream_address_raw_1": "rtsp:",                                   // 正面原始视频流     
        "stream_address_raw_2": "rtsp:"                                    //侧面原始视频流
  
    }
}

查询娃娃商品信息

请求URL：{site_url}/api/index.php?app=doll&act=get_goods_info
请求方式：GET

请求参数	说明	值
platform	平台方	如：qyguo
goods_id	商品id	如：1245312

应答包：  
{
    "done": true,
    "msg": "",
    "retval": {
        "goods_id": "1711208844",                                     //娃娃商品id
        "send_type": "0",                                            //发货方式 1：自行发货 2：供应商发货
        "goods_name": "围巾犬",                                        //商品名称
        "default_image": "",                                          //默认图片
        "front_image": "",                                            //正面图片
        "side_image": "",                                             //侧面图片
        "back_image": ""                                              //后面图片
    }
}

批量查询娃娃商品信息

请求URL：{site_url}/api/index.php?app=doll&act=get_goods_infos
请求方式：GET

请求参数	说明	值
platform	平台方	如：qyguo
goods_ids	商品id,多个id逗号隔开	如：1711205201,1711205310

应答包：  
{
    "done": true,
    "msg": "",
    "retval": {
	"1711205201": {
		"goods_id": "1711205201",                    //娃娃商品id
		"goods_name": "长条狗",                       //商品名称
		"send_type": "0",                            //发货方式 1：自行发货 2：供应商发货
		"default_image": "",                         //默认图片
		"front_image": "",                           //正面图片
		"side_image": "",                            //侧面图片
		"back_image": ""                             //后面图片
	},
	"1711205310": {
		"goods_id": "1711205310",
		"goods_name": "绿头猫头鹰",
		"send_type": "0",
		"default_image": "",
		"front_image": "",
		"side_image": "",
		"back_image": ""
	}
    }
}

创建订单接口

请求URL：{site_url}/api/index.php?app=buyer_order&act=create_order 请求方式：POST

请求参数	说明	值
platform	平台方	如：qyguo
user_id	用户id是唯一的	如：420808
username	用户名	如：13602416937
goods_list	商品列表	json
goods_id	商品id	goods_list下参数
num	商品数量	goods_list下参数
address	地址	如：广州天河街道3号
mobile	电话	如：苏苏苏
consignee	收货人	如：100000

应答包：  
{
    "done": true,                                               
    "msg": "创订单成功",
    "retval": [{
        Order_id:201710200478                                   //订单号
     }]
}

订单列表

请求方式：GET
说明：用于平台订单列表内嵌页面（如果平台有开发用户订单管理页面，则不需要）
请求URL：{site_url}/api/index.php?app=buyer_order&act=order_list&platform=qyguo&user_id=420808&page=1 &sign=fe96666d459e71cd089af5c9f29f73d2&ts=1509695453

地址列表

请求方式：GET
说明：用于平台订单列表内嵌页面（如果平台有开发用户订单管理页面，则不需要）
请求URL：{site_url}/api/index.php?app=my_address&platform=qyguo &user_id=420808&&sign=fe96666d459e71cd089af5c9f29f73d2&ts=1509695453

设置中奖概率

请求URL：{site_url}/api/index.php?app=doll&act=set_winning_probability
请求方式：get

请求参数	说明	值
platform	平台方	如：qyguo
winning_probability	中奖概率	范围: 1~888, 如：100：100次出一次强抓力数字越大越难中奖
device_id	娃娃机设备id	如：kZFui5UaYHGfkPNBauvq3C

应答包：  
{
    "done": true,
    "msg": "操作成功",
    "retval": []
}

设置抓力模式

请求URL：{site_url}/api/index.php?app=doll&act=set_holding_mode
请求方式：get

请求参数	说明	值
platform	平台方	如：qyguo
holding_mode	抓力设置模式	1:弱抓力模式2:固定强抓力3:随机强抓力4:固定强抓力-补5:随机强抓力-补
device_id	娃娃机设备id	如：kZFui5UaYHGfkPNBauvq3C

应答包：  
{
    "done": true,
    "msg": "操作成功",
    "retval": []
}

设置设备游戏时间

请求URL：{site_url}/api/index.php?app=doll&act=set_playtime
请求方式：get

请求参数	说明	值
platform	平台方	如：qyguo
playtime	时间	范围: 5~60, 如：30
device_id	娃娃机设备id	如：kZFui5UaYHBauvq3C

应答包：  
{
    "done": true,
    "msg": "操作成功",
    "retval": []
}

获取设备参数信息

请求URL：{site_url}/api/index.php?app=doll&act=get_device_setting
请求方式：get

请求参数	说明	值
platform	平台方	如：qyguo
device_ids	娃娃机设备id 多个用逗号隔开	如：kZFui5UaYHBauvq3C，
AfyThD7bQmqtVayXcCfP2a

{
    "done": true,
    "msg": "",
    "retval": [{
        "device_id": "AfyThD7bQmqtVayXcCfP2a",                       //设备ID
        "time": 20,                                                  //游戏时间
        "holding_mode":2,                                            //抓力模式
        "winning_probability": 25                                    //中奖概率
    }]
}

回调接口（平台提供）

回调抓取结果接口

请求方式：GET

请求参数	说明	值
platform	平台方	如：qyguo
user_id	用户id是唯一的	如：420808
log_id	操作id	如：1360
address	地址	如：广州天河街道3号
consignee	收货人	如：苏苏苏
mobile	手机	如：136024
goods_id	设备商品id	如：100000
operate_result	操作结果	1:成功2：失败
sign	标识	检验url合法用
ts	时间戳

回调订单结果接口

请求方式：GET

请求参数	说明	值
order_id	订单ID	如：7432
status	订单状态（30:已发货）	如：30
mode	物流方式
EXPRESS	使用物流订单
NO_EXPRESS	无需物流	如：EXPRESS
shipping_no	物流单号	如：420679234230
shipping_com	物流公司标识，用于快递100查询单号的参数	如：shunfeng
shipping_name	物流公司名字	如：“顺丰”
shipping_memo	发货人备注	如：“已发货”
shipping_time	发货时间	如：1511079568
sign	标识检验url合法用
ts	时间戳

通知同步设备状态

请求方式：GET

请求参数	说明	值
notify_type	通知类型	1
device_id	设备id	如：adf2sdfeww
push_status	推流情况	1：推流失败，2：推流恢复
device_status	设备情况	1：机器故障，2：机器恢复
notify_msg	失败原因
sign	标识检验url合法用
ts	时间戳

通知同步设备变更

请求方式：GET

请求参数	说明	值
notify_type	通知类型	2
fault_device_id	故障设备id	如：adf2sdfeww
new_device_id	新设备id
room_id	房间id
camera_front	正面摄像头名字（腾讯云）
camera_side	侧面摄像头名字（腾讯云）
sign	标识	检验url合法用
ts	时间戳

Websocket 娃娃机操作方案

机器如果分配成功，接口 {site_url}/api/index.php?app=doll&act=assign&device_id=kZFui5UaYHGfkPNBauvq3C&user_id=420808&platform=qyguo&sign=fe96666d459e71cd089af5c9f29f73d2返回结果中多加一个参数ws_url ，此url对应的是本次游戏发送操作指令的socket连接，连接需要带上用于校验的token，此token为一次性消费推荐令牌桶模式，token与用户关联以支持断线重连
例如：ws://testdoll.artqiyi.com:9501?device_id=Z87Ac6pFzeQ96rkoi55ktp&user_id=1&platform=qyguo&ts=1512033962&sign=585640508f202e85bdfaf002b30ed97c

通讯接口

1.握手成功

服务端收到建立连接的请求校验成功后，返回这条消息，代表服务端正常，服务器返回 {“type":"Ready"}

2.操作娃娃机

已连接成功，客户端与服务器正常通讯客户端主动发送 {"type":"Control","data":"1"} data：操作指令 1.前进 2.后退 3.向左 4.向右 5.抓取娃娃 6.前进终止 7.后退终止 8.向左终止9.向右终止

3、操作娃娃机结果

客户端发送操作命令后服务端主动发送 {“type”:”Control_result”,”data":{"command":1}} 服务端发送，表示操作按键成功

4、抓取结果

客户端发送抓取娃娃命令后，服务端主动发送{“type”:”Result”,”data":{"operate_result":1}} operate_result：1.成功2.失败

服务端发送游戏结果

5.心跳请求

已连接成功，客户端与服务器正常通讯客户端主动发送 {“type”:”Delay”}

游戏过程中的心跳连接，客户端发送

6.心跳响应

已连接成功，客户端与服务器正常通讯服务端主动发送 {“type”:”Delay_result”,”data”:{“request_time":1512037831.8698}}