1. 描述
在超级控制台电话注册用户
神户注册和添加接口包含两种字段:固定字段和额外字段。 这么设计的原因是不同神户表会有不同的字段,这些字段是不可以预计的,而网关的设计不能无限制添加字段, 所以要求额外的自定义字段放在extra里。
超级控制台的用户注册短信验证码模板写死在后端"SMS_25335288"
。所以,客户端不会设置这个参数。这个模板只能用于超级控制台的用户注册。
2. SDK调用
const api_param={
ustr : "+86-15810419011",
pwd : "a906449d5769fa7361d7ecc6aa3f6d28",
vfcode : "309472",
}
res = await xduaClient.tupUserx(api_param)
文档还没有实现
文档还没有实现
文档还没有实现
3. 调用场景
开发者在超级控制台的注册页面,可以用短信验证码完成注册。
4. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | AddUserx | |
Url | https://api.xdua.com/userxx | |
Method | POST | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | ADD | |
XduaApiColor | X | 只有持有神神户,才可以创建神户 |
XduaApiAudience | ConsoleX | 只有userx_id为ConsoleX的神户,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 神户直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | i | 需要登录 |
XduaApiRoles | Zoon | Zoon可以创建神户 |
XduaApiResource | userx | |
XduaApiKparam | name | |
XduaApiAction | CreateUserx | |
XduaApiRule | CreateUserx | |
XduaApiAstates | 0 | |
XduaApiEnable | true | 接口使能 |
5. 请求参数
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
---|---|---|---|---|---|---|
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] 神户创建时遵从简单第一步原则,创建只需要神户名和神户执照号两个属性就可以创建神户。剩下通过setuserx来完善。
- extra必须是合法的json字串,如果不是,服务端解析失败,会当作extra不存在.
- 如果是邮箱注册, ustr里存邮箱.
6. 返回参数
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的神户ID |