1. 描述
创建社区。
2. 调用场景
开发者登录超级控制台后,以Root角色发起操作。
[NOTE|label:为什么不用None角色创建社区] 社区Zone的创建属于非常谨慎的资源,不应该由开发者自行创建。以后可以在后台配置这个动作可以让给None角色。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddZone | |
Url | https://api.xdua.com/zone | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神令牌,才可以创建社区 |
XduaApiAudience | ConsoleX | 只有app_id为ConsoleX的应用,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 社区直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 需要登录 |
XduaApiRoles | None | 只要登录就可以创建社区 |
XduaApiResource | zone | |
XduaApiKparam | name | |
XduaApiAction | CreateZone | |
XduaApiRule | CreateZone | |
XduaApiAstates | 0 | 按序app,zone,corp,shop,user,token,login的状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
name | body | string | 是 | 健康手环 | 社区的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 | |
avatar | body | string | 否 | 社区图标,不超过40个字符。 | ||
brief | body | string | 否 | 社区描述,不超过64个字符。 |
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的社区ID |
6. 错误码
7. SDK调用
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})
//运行如下代码
api_param = {}
let res = await xduaClient.addZone()
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="java" -%}
文档还没有实现
```bash
文档还没有实现
bash