1. 描述

创建户串。

2. 调用场景

开发者登录超级控制台后,可以以Butler角色创建自己的户串。户串创建目前只能由Butler进行。

创建户串需要用户先登录自己的账户，进入企业，店铺，然后创建。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name AddRoom
Url https://api.xdua.com/ustr
Method POST
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod ADD
XduaApiColor R 只有持有神户串，才可以创建户串
XduaApiAudience ConsoleR 只有ustr_id为ConsoleX的户串，也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 户串直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i 需要登录
XduaApiRole God 目前地球号只允许God添加户串,未来这个功能会让给一个专门维护户串和设备录入的角色。
XduaApiResource ustr
XduaApiKparam pkey 在阿里云物联网平台创建的户串的ProductKey
XduaApiAction CreateRoom
XduaApiRule CreateRoom
XduaApiAstates 0 所有的资源都要确认state是0
XduaApiEnable true 接口使能

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
type body String 是 无 户串的种类 户串的种类
ustr body String 是 无 户串的值 户串的值
名称 说明 类型 示例 说明
M Mail string jiaoshuai@xdua.com 邮箱
T Tel string +86-15810419011 电话号码
I ID string rYub4wrT 身份证号
V Veixin string rYub4wrT 微信的Openid

[!NOTE|label:当微信扫码绑定时] 当用微信扫码绑定的时候, ustr字段放的是微信扫码SDK生成的code字段，样子如下http://api.svkernel.xdua.com/ustr?type=V&ustr=071iJVFa1t6kUz0ADeJa13Knog1iJVFt

5. 返回参数

这些参数是直接从腾讯的接口里获取的，字段也没有改变,保持与腾讯一致。

名称 位置 类型 示例 说明
head_img result string 头像
nickname result string 昵称
openid result string 微信openid
unionid result string 微信的unionid 
{
    head_img: "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIYhTiblmCXm2ekuyvlSkROJ3gMWNZPvw5RXf6Eh97ibBLexRAQQM7hh7uGQ1w9a7PMmJ9mibfT79Hdg/132",
    nickname: "焦帅",
    openid: "oA9KU5q5B5163ozPzw1C_GFd7ULc",
    unionid: "o6EyZv2HuY8STp3hLBV9TFOqs84U",
}

6. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

7. SDK调用




const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*-----------------------------------------------------------
 * 首先在控制台点击企业按钮，进入企业
 *---------------------------------------------------------*/

api_name = "登续到济南分所";
add_param = {
    type  :   "V",
    ustr  :  "071iJVFa1t6kUz0ADeJa13Knog1iJVFt",
}

res = await xduaClient.addUstr(add_param)
if(res.status == 200){
    if(res.error == 0){
        got_zone_id = res.result.id;
        console.log(api_name+"成功 ");
    }else{
        got_zone_id = res.result.id;
        console.log(res);
    }
}else{
    console.log(res);
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

results matching ""

    No results matching ""