Oray开放平台开发指引

花生壳SDK嵌入文档

一、创建花生壳应用

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

二、集成SDK

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

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

命令行参数说明:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
-h, --help       print this help
-s, --server api server, default https://hsk-embed.oray.com
-l, --log write log file, default C:\Users\Q\phtunnel.log
-v, --verbose print logs instead of write log file
-q, --qrcode print login qrcode
-r, --rpc enables local rpc, default no
-c, --config default: C:\Users\Q\phtunnel.json
-p, --pid pid file, default: C:\Users\Q\phtunnel.pid
-f, --forward Remote admin forward, default: 127.0.0.1:80
-d,--daemon Run as daemon in linux system
-S,--service Run as service in window system
-i,--appid App ID(花生壳应用ID)
-k,--appkey App Key(花生壳应用Key)
-e,--deviceinfo User defined data(自定义信息采集, 格式: "name":value; "name2":value2, ...)

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

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

返回数据

1
2
3
4
5
6
7
8
9
{
"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. 二维码刷新接口
接口 获取二维码的图片地址以及二维码有效期
地址 https://hsk-embed.oray.com/devices/qrcode
方法 POST
参数 {“sn”: “设备sn”, “password”: “设备密码”}
参数类型Content-Type application/json
返回格式 Json

返回数据

1
2
3
4
5
{
"qrcode":"二维码地址",
"qrcodeimg":"二维码图片地址",
"expires":"有效期"
}
  1. 映射管理接口
接口 映射管理接口返回管理url,自动登录b.oray.com进行映射管理。
地址 http://127.0.0.1:16062/ora_service/getmgrurl
方法 GET
参数
返回格式 Json

返回数据

1
2
3
4
{
"result_code":0,
"data":"https://xxxx/xxxx"// 为空时说明没有登录帐号
}
  1. 设备帐号解绑接口
接口 如果当前已登录帐号,则退出当前帐号并解绑。
地址 https://hsk-embed.oray.com/devices/unbinding
方法 POST
参数 {“sn”: “设备sn”, “password”: “设备密码”}
参数类型Content-Type application/json
返回格式
返回数据 成功:HTTP状态码为200, 失败:HTTP状态码为500

三、测试花生壳应用

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