花生壳SDK嵌入文档

一、创建花生壳应用

登录贝锐开发者平台( https://open.oray.com )，申请成为开发者。创建花生壳应用同时获得AppID和AppKey。

二、集成SDK

1、指定AppID和AppKey，以及自定义信息采集字段， 启动花生壳核心程序phtunnel，命令行如下：

phtunnel.exe --appid=AppID --appkey=AppKey --deviceinfo=自定义信息采集字段 -d

命令行参数说明：

-h, --help 打印帮助
-s, --server 接口服务 ， 默认 https://hsk-embed.oray.com
-l, --log 写入日志文件, 默认 C:\Users\Q\phtunnel.log
-v, --verbose 打印日志而不是写入日志文件
-q, --qrcode 打印二维码
-n, --noqr 账号密码登录
-r, --rpc 启用本地rpc，默认否
-c, --config 默认: C:\Users\Q\phtunnel.json
-p, --pid pid 文件, 默认: C:\Users\Q\phtunnel.pid
-f, --forward 远程管理地址, 默认: 127.0.0.1:80
-d,--daemon 在linux系统中作为守护进程运行
-S,--service 在windows系统中作为服务运行

2、集成扫码登录和管理接口

1.1获取SN 和 密码 接口

接口	获取SN 和 密码 接口
地址	http://127.0.0.1:16062/ora_service/getsn
方法	GET
参数	无
返回格式	Json

返回数据

{
"result_code": 0, // 非0代表错误
"data":{
"device_sn": "设备SN",
"device_sn_pwd": "设备密码",
"status": 1, // 在线状态 重试(3), 登录中(2) 在线(1), 离线(0)
"public_ip": "116.235.167.135" // 公网IP
}
}

1.2二维码刷新接口

接口	获取二维码的图片地址以及二维码有效期
地址	https://hsk-embed.oray.com/devices/qrcode
方法	POST
参数	{"sn": "设备sn", "password": "设备密码"}
参数类型Content-Type	application/json
返回格式	Json

返回数据

{
"qrcode":"二维码地址",
"qrcodeimg":"二维码图片地址",
"expires":"有效期"
}

1.3映射管理接口

接口	映射管理接口返回管理url，自动登录b.oray.com进行映射管理。
地址	http://127.0.0.1:16062/ora_service/getmgrurl
方法	GET
参数	无
返回格式	Json

返回数据

{
"result_code":0,
"data":"https://xxxx/xxxx"// 为空时说明没有登录账号
}

1.4设备账号解绑接口

接口	如果当前已登录账号，则退出当前账号并解绑。
地址	https://hsk-embed.oray.com/devices/unbinding
方法	POST
参数	{"sn": "设备sn", "password": "设备密码"}
参数类型Content-Type	application/json
返回格式	无
返回数据	成功：HTTP状态码为200， 失败：HTTP状态码为500

三、测试花生壳应用

在开放平台创建的应用，默认时调试状态，需要增加测试的花生壳账号，应用发布前只有添加的测试账号才能登录使用成功。通过测试后才能发布花生壳应用。