氦氪云端API文档(C2)

关键词

S表达式（SEXP）：准确地说是lambdaTM代码，SEXP既是代码也是数据，这对于理解指令和后续描述的一些场景非常重要
请求参数(Request Params): 即是指常规的请求中所带参数
user_token: 用户授权识别码
device_token: 设备授权识别码
C1：WEB API
C2：企业数据服务API
C3：WEBSOCKE API & TCP API

C2-4 固件升级信息

GET http://poseidon.hekr.me/appfirmware.json?mid=xxx&tid=xxx&binver=xxx&bintype=xxx

说明

调用该API可获取比现有版本更大的固件升级地址及相关信息。如果APP获取的bintype=A，则调用API时bintype=B；获取bintype=B，则调用API时bintype=A。当APP获得返回参数中code=400或compulsory=1时，APP均不用升级固件。

请求参数

参数名称	是否可选	参数类型	取值范围	说明
mid	必选	字符串	正整数	型号唯一id
binver	必选	字符串	1.0.0.0-99.99.99.99	固件版本号
bintype	必选	字符串	"A"或"B"	固件使用类型
tid	可选	字符串	长度不超过64字符的合法tid	设备唯一id

{
  "code": 200,
  "message": "success",
  "value": {
    "compulsory": 0,
    "bintype": "B",
    "mid": 32,
    "binver": "1.14.0.0",
    "updatelog": "测试",
    "tid": "",
    "url": "http://7xkm7f.dl1.z0.glb.clouddn.com/CS_CS_SAD_v1.14.0.0_32_B.bin",
    "md5": "ab6469e59ba1d11c037d67b8d0a67930"
  }
}

code 成功返回200，失败返回400，固件最新版本返回204
message 成功返回"success"，失败返回"bad request"，固件最新版本返回"this is the latest"
compulsory 是否强制升级（1为强制，0为不强制）
bintype 固件返回的类型
mid 型号唯一id
updatelog 更新日志
tid 设备唯一id
url 固件升级地址
md5 固件MD5值

C2-6 获取HTML5页面信息

POST http://posedion.hekr.me/template/update.json

说明

调用该API可获取一个型号的HTML5页面信息

请求参数类型

contentType:application/json;

请求参数

{
  "accesskey":
  "azBWMkREck9hczhzWmNOM3J6RlZjVGROc3REdHFNZ2JaMlJuemFoU1lOVlBBSXYxSm5aRXNueXU0b2JjK01mU09J",
  "_csrftoken_": "v1YN",
  "template": [
    {
      "name": "1",
      "version": "1.1"
    }
  ],
  "platform": "ios"
}

参数名称	是否可选	参数类型	取值范围	说明
accesskey	必选	字符串	合法的accesskey	用户的accesskey
_csrftoken_	必选	字符串	随机四位数	与cookie中该值保持一致
name	必选	字符串	正整数	型号唯一id
version	必选	字符串	如"1.1"	使用版本号
platform	必选	字符串	"ios"或"android"	使用平台

{
  "code": 200,
  "message": "success",
  "value": [
    {
      "name": "1",
      "version": "1.1",
      "hash": "dc5257e373a5826f6a395b0257f7cafc",
      "url": "http://7xlocu.dl1.z0.glb.clouddn.com/ios/1441938965298.zip"
    }
  ]
}

code 成功返回200失败返回400
message 成功返回"success"失败返回"bad request"
name 型号唯一id
version 使用版本号
hash HTML5的zip压缩包的MD5值
url HTML5的zip压缩包的地址

C2-7 用户对厂家意见反馈

POST http://poseidon.hekr.me/user/feedbackaftersale.json?pid=xxx&mid=xxx&tid=xxx&cid=xxx&accesskey=xxx&utel=xxx&feedback=xxx&content=xxx

说明

该API是接收用户给厂家的反馈意见。

请求参数

参数名称	是否可选	参数类型	取值范围	说明
pid	必选	字符串	正整数	厂商id
mid	必选	字符串	正整数	型号唯一id
cid	必选	字符串	正整数	品类唯一id
accesskey	必选	字符串	合法的accesskey	用户的accesskey
feedfack	必选	字符串	暂无	反馈类型
content	必选	字符串	无	反馈内容
tid	可选	字符串	长度不超过64字符的合法tid	设备唯一id
utel	可选	字符串	合法的联系方式	用户联系方式

{
  "code": 200,
  "message": "success"
}

code 成功返回200失败返回400
message 成功返回"success"失败返回"bad request"

C2-8 用户对氦氪的意见反馈

POST http://poseidon.hekr.me/tucao.json?userAccessKey=xxx&content=xxx

说明

该API是接收用户给氦氪意见反馈。

请求参数

参数名称	是否可选	参数类型	取值范围	说明
accesskey	必选	字符串	合法的accesskey	用户的accesskey
content	必选	字符串	无	反馈内容

{
  "code": 200,
  "message": "success"
}

code 成功返回200失败返回400
message 成功返回"success"失败返回"bad request"

C2-9 添加企业私有云

POST http://poseidon.hekr.me/adddomain.json?rr=xxx&type=xxx&value=xxx

说明

该API是为用户提供新建企业私有云功能。

请求参数

参数名称	是否可选	参数类型	取值范围	说明
rr	必选	字符串	如"b.test"	域名
type	必选	字符串	A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV	记录类型
value	必选	字符串	IP地址	记录值

{
  "code": 200,
  "message": "success",
  "value": {
    "RequestId": "B77F0B07-5C67-459F-BFA2-A13A86E14174",
    "RecordId": "69332436"
  }
}

code 成功返回200失败返回400
message 成功返回"success"失败返回"bad request"
RequestId 系统返回的唯一识别码
RecordId 私有云唯一id

C2-10 删除企业私有云

POST http://poseidon.hekr.me/deletedomain.json?rr=xxx&type=xxx&value=xxx

说明

该API是为用户提供删除企业私有云功能。

请求参数

参数名称	是否可选	参数类型	取值范围	说明
rr	必选	字符串	如"b.test"	域名
type	必选	字符串	A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV	记录类型
value	必选	字符串	IP地址	记录值

{
  "code": 200,
  "message": "success",
  "value": {
    "RequestId": "D0C33B3B-F26D-4724-85CB-A115B88D5B64",
    "RecordId": "69331404"
  }
}

code 成功返回200失败返回400
message 成功返回"success"失败返回"bad request"
RequestId 系统返回的唯一识别码
RecordId 私有云唯一id

C2-11 修改企业私有云

POST http://poseidon.hekr.me/editdomain.json?orr=xxx&otype=xxx&ovalue=xxx&&nrr=xxx&ntype=xxx&nvalue=xxx

说明

该API是为用户提供修改企业私有云功能。

请求参数

参数名称	是否可选	参数类型	取值范围	说明
orr	必选	字符串	如"b.test"	老域名
otype	必选	字符串	A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV	老记录类型
ovalue	必选	字符串	IP地址	老记录值
nrr	必选	字符串	如"b.test"	新域名
ntype	必选	字符串	A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV	新记录类型
nvalue	必选	字符串	IP地址	新记录值

{
  "code": 200,
  "message": "success",
  "value": {
    "RequestId": "9F7F3759-6664-4F61-B4DF-94CFA6C37E47",
    "RecordId": "69332436"
  }
}

code 成功返回200失败返回400
message 成功返回"success"失败返回"bad request"
RequestId 系统返回的唯一识别码
RecordId 私有云唯一id

C2-12 查询企业私有云

POST http://poseidon.hekr.me/querydomain.json?rr=xxx&type=xxx&value=xxx

说明

该API是为用户提供查询企业私有云功能。

请求参数

参数名称	是否可选	参数类型	取值范围	说明
rr	必选	字符串	如"b.test"	域名
type	必选	字符串	A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV	记录类型
value	必选	字符串	IP地址	记录值

{
  "code": 200,
  "message": "success",
  "value": {
    "Line": "default",
    "RR": "b.test",
    "Type": "A",
    "RequestId": "60759959-F255-4608-9846-6B2AF550D83F",
    "DomainName": "hekr.me",
    "Value": "127.0.0.1",
    "RecordId": "69332436",
    "TTL": 600
  }
}

code 成功返回200失败返回400
message 成功返回"success"失败返回"bad request"
Line 解析线路
RR 域名
Type 记录类型
RequestId 系统返回的唯一识别码
DomainName 主域名
Value 记录值
RecordId 私有云唯一id
TTL 生存时间