1. 描述
创建床位。
2. 调用场景
开发者登录超级控制台后,可以以God角色创建自己的床位。床位创建目前只能由God进行。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddBed | |
Url | https://api.xdua.com/bed | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神床位,才可以创建床位 |
XduaApiAudience | ConsoleX | 只有bed_id为ConsoleX的床位,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 床位直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRole | God | 目前地球号只允许God添加床位,未来这个功能会让给一个专门维护床位和设备录入的角色。 |
XduaApiResource | bed | |
XduaApiKparam | pkey | 在阿里云物联网平台创建的床位的ProductKey |
XduaApiAction | CreateBed | |
XduaApiRule | CreateBed | |
XduaApiAstates | 0 | 所有的资源都要确认state是0 |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
type | body | String | 是 | 无 | Mats | 床位类型代码,本字段受bed_type表的code字段外键约束 |
man | body | String | 是 | 无 | Minew | 制造商代码,本字段受bed_man表的code字段外键约束 |
model | body | String | 是 | 无 | Minew | 制造商代码,从床位的包装盒,介绍中获取 |
name | body | String | 是 | 无 | Minew | 床位的平台系统名字,由录入者自定义 |
vlot | body | Integer | 是 | 无 | 3600 | 床位的日志存活时间 |
brief | body | String | 否 | 空 | 这是一个* | 床位的介绍 |
cost | body | Double | 是 | 空 | 45.0 | 床位的采购价格或者平摊下来的生产制造价格 |
earn | body | Double | 是 | 空 | 60.0 | 对外销售价格,包含设置人工成本 |
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的床位ID |
6. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
7. SDK调用
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})
/*----------------------------
* 运行如下代码
* 下面的代码是直接可以运行的
*--------------------------*/
const add_params = {
type:"Test", //类别
model:"Motest2", //型号,Motest这个词取自Model Test合词
vlot:360, //本床位对应的所有设备的数据在日志表里存6分钟数据
name:"测试床位", //名字
man:"xdua.com", //床位生产商,地球号团队制作的硬件的生产商是xuda.com
pkey:"a1lPKOTest2", //阿里云平台ProductKey,从那里拷贝过来
brief:"接口测试", //简介
cost:45, //采购或者生产这个硬件的成本
earn:60, //对外销售价格
}
let res = await xduaClient.addBed(add_params)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash