1. 描述
创建社傀。 社傀在控制台创建傀儡社傀。
社傀注册和添加接口包含两种字段:固定字段和额外字段。这么设计的原因是不同社傀表会有不同的字段,这些字段是不可以预计的,而网关的设计不能无限制添加字段,所以要求额外的自定义字段放在extra里。
2. 调用场景
开发者登录超级控制台后,可以以Zoon社傀创建自己的社傀。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | Addrobot | |
Url | https://api.xdua.com/robotx | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神社傀,才可以创建社傀 |
XduaApiAudience | ConsoleX | 只有robot_id为ConsoleX的社傀,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 社傀直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRoles | Zoon | Zoon可以创建社傀 |
XduaApiResource | robot | |
XduaApiKparam | name | |
XduaApiAction | Createrobot | |
XduaApiRule | Createrobot | |
XduaApiAstates | 0 | |
XduaApiEnable | true | 接口使能 |
4. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
name | body | string | 是 | 健康手环 | 社傀的名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~32个字符 | |
avatar | body | string | 否 | 社傀图标,不超过40个字符。 | ||
brief | body | string | 否 | 社傀描述,不超过64个字符。 |
|dsn |body|string|设备序列号 |必须 | |type |body|string|android:android应用,ios:ios应用,browser:浏览器应用,pc:pc机的可执行文件exe或者standalone部署的应用|必须 | |model |body|string|设备的模型 |必须 | |man |body|string|设备生产厂商 |必选 | |os |body|String|设备操作系统 |必选 | |pkg |body|String|应用包名|必选 | |channel|body|String|渠道名 |必选 |
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
by | body | String | 否 | "tel"/"mail" | 必选 | ||
ustr | body | String | 否 | 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn | 必选 | ||
pwd | body | String | 否 | 密码,32位md5码 | 必选 | ||
vfcode | body | String | 否 | 验证码 | 可选 | ||
shop | body | String | 否 | 店铺 | 必选 | ||
role | body | String | 否 | 角色,默认"none" | 可选 | ||
tel | body | String | 否 | 电话,如果电话注册,ustr会覆盖tel字段. | 可选 | ||
body | String | 否 | 邮箱,如果邮箱注册,ustr会覆盖mail字段. | 可选 | |||
extra | body | String | 否 | JSON,额外字段存放的地方 | 可选 | ||
tabx | body | String | 否 | 注册的新社傀的extra字段存放在哪个社傀表里 | 必选 | ||
avatar | body | string | 否 | 社傀图标,不超过40个字符。 | |||
brief | body | string | 否 | 社傀简介,不超过64个字符。 | |||
name | body | string | 是 | 中国科学院计算技术研究所 | 社傀的名称。必须与营业执照一致。 |
[!note] 社傀创建时遵从简单第一步原则,创建只需要社傀名和社傀执照号两个属性就可以创建社傀。剩下通过setrobot来完善。
- extra必须是合法的json字串,如果不是,服务端解析失败,会当作extra不存在.
- 如果是邮箱注册, ustr里存邮箱.
5. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的社傀ID |