外观
1. 检测账号是否存在
接口路径
地址:https://console.casdao.com:9001/casdao/api/v1.0/system/register/existence
请求方式
POST 方式,请求参数为 form 格式
输入说明
请求头
请求头 |
---|
无 |
请求体
请求参数 | 选项 | 类型 | 说明 |
---|---|---|---|
username | 必选 | 字符串 | 账号 |
示例
json
{
"username": "duxwtest2"
}
输出说明
请求参数 | 说明 |
---|---|
code | 响应码,成功为 200,非 200 状态码为失败,参考 msg 错误信息 |
msg | 响应信息,成功状态下为 null,失败状态下为具体错误信息 |
data | 响应数据,布尔型,true 为存在,false 为不存在 |
示例
json
{
"code": 200,
"msg": null,
"data": false
}
2. 获取手机验证码
说明:新用户注册需绑定有效手机号,此接口为获取验证码
接口路径
地址:https://console.casdao.com:9001/casdao/api/v1.0/system/register/sms/code
请求方式
POST 方式,请求参数为 JSON 格式
输入说明
请求头
请求头 |
---|
无 |
请求体
请求参数 | 选项 | 类型 | 说明 |
---|---|---|---|
mobilePhone | 必选 | 字符串 | 手机号 |
module | 必选 | 字符串 | 固定值:注册验证 |
origin | 必选 | 字符串 | 固定值:console |
departmentId | 必选 | 整数型 | 组织 ID,见 下表 |
departmentId 说明
组织 ID | 组织名称 |
---|---|
2 | 算力互联 |
5 | 汴水超算 |
... | ... |
可以联系客服获取组织 ID。
示例
json
{
"mobilePhone": "18555666633",
"module": "注册验证",
"origin": "console",
"departmentId": 2
}
输出说明
请求参数 | 说明 |
---|---|
code | 响应码,成功为 200,非 200 状态码为失败,参考 msg 错误信息 |
msg | 响应信息,成功状态下为 null,失败状态下为具体错误信息 |
data | 响应数据 |
示例
json
{
"code": 200,
"msg": null,
"data": null
}
3. 账号注册
接口路径
地址:https://console.casdao.com:9001/casdao/api/v1.0/system/register/addition
请求方式
POST 方式,请求参数为 JSON 格式
输入说明
请求头
请求头 |
---|
无 |
请求体
请求参数 | 选项 | 类型 | 说明 |
---|---|---|---|
roleId | 必选 | 整数型 | 角色 id,固定值 1 |
roleCategory | 必选 | 整数型 | 角色种类,固定值 1 |
username | 必选 | 字符串 | 用户名 |
password | 必选 | 字符串 | 密码 |
confirmPassword | 必选 | 字符串 | 确认密码 |
mobilePhone | 必选 | 字符串 | 手机号 |
code | 必选 | 字符串 | 验证码 |
departmentId | 必选 | 整数型 | 组织 ID,见上表 departmentId 说明 注意:此值与获取手机验证码时传入的值保持一致。 |
origin | 必选 | 字符串 | 固定值:console |
示例
json
{
"roleId": 1,
"roleCategory": 1,
"username": "duxwtest2",
"password": "xiaojing@123",
"confirmPassword": "xiaojing@123",
"mobilePhone": "13244445555",
"code": "947310",
"departmentId": 2,
"origin": "console"
}
输出说明
请求参数 | 说明 |
---|---|
code | 响应码,成功为 200,非 200 状态码为失败,参考 msg 错误信息 |
msg | 响应信息,成功状态下为 null,失败状态下为具体错误信息 |
data | 响应数据 |
示例
json
{
"code": 200,
"msg": null,
"data": 151
}
4. 二级账号注册
接口路径
地址:https://console.casdao.com:9001/casdao/api/v1.0/system/user/addition
请求方式
POST 方式,请求参数为 JSON 格式
输入说明
请求头
请求头 | 说明 |
---|---|
X-Auth-Token | Token 值 |
请求体
请求参数 | 选项 | 类型 | 说明 |
---|---|---|---|
roleId | 必选 | 整数型 | 角色 id,固定值 4 |
roleCategory | 必选 | 整数型 | 角色种类,固定值 4 |
username | 必选 | 字符串 | 用户名 |
password | 必选 | 字符串 | 密码 |
mobilePhone | 必选 | 字符串 | 手机号 |
departmentId | 必选 | 整数型 | 组织 ID,见上表 departmentId 说明 |
departmentName | 必选 | 字符串 | 组织名称,见上表 departmentId 说明 |
origin | 必选 | 字符串 | 固定值:console |
parentId | 必选 | 整数型 | 固定值:-1 |
clusterAccounts | 必选 | 数组型 | 固定值:空数组[] |
status | 必选 | 整数型 | 固定值:0 |
notify | 必选 | 整数型 | 固定值:3 |
module | 必选 | 字符串 | 固定值:'密码通知' |
name | 非必选 | 字符串 | 姓名 |
telephone | 非必选 | 字符串 | 座机号 |
非必选 | 字符串 | 邮箱 | |
organization | 非必选 | 字符串 | 部门 |
duty | 非必选 | 字符串 | 职位 |
enterprise | 非必选 | 字符串 | 单位名称 |
示例
json
{
"roleId": 4,
"roleCategory": 4,
"username": "duxwtest2",
"password": "xiaojing@123",
"mobilePhone": "13244445555",
"departmentId": 2,
"departmentName": "算力互联",
"origin": "console",
"parentId": -1,
"clusterAccounts": [],
"status": 0,
"notify": 3,
"module": "密码通知",
"name": "duxw",
"telephone": "010-32854783",
"email": "duxw@duxw.com",
"organization": "CIBC",
"duty": "员工",
"enterprise": "算力互联"
}
输出说明
请求参数 | 说明 |
---|---|
code | 响应码,成功为 200,非 200 状态码为失败,参考 msg 错误信息 |
msg | 响应信息,成功状态下为 null,失败状态下为具体错误信息 |
data | 响应数据 |
示例
json
{
"code": 200,
"msg": null,
"data": 151
}
5. 登录
说明:账号登录接口,登录成功后返回 Token 值,为后续接口提供 Token 值,找相关人员开通账号和密码。Token 有效时间为 2 小时,每次使用 Token 调用接口时,会自动刷新 Token 时长为 2 小时。
接口路径
地址:https://console.casdao.com:9001/casdao/api/v1.0/system/auth/login
请求方式
POST 方式,请求参数为 JSON 格式
输入说明
请求头
请求头 |
---|
无 |
请求体
请求参数 | 选项 | 类型 | 说明 |
---|---|---|---|
username | 必选 | 字符串 | 用户名 |
password | 必选 | 字符串 | 密码 |
source | 必选 | 字符串 | 固定值 console |
departmentId | 必选 | 整数型 | 组织 ID,见上表 departmentId 说明 |
示例
json
{
"username": "zhangsan",
"password": "123456",
"source": "console",
"departmentId": 2
}
输出说明
请求参数 | 说明 |
---|---|
code | 响应码,成功为 200,非 200 状态码为失败,参考 msg 错误信息 |
msg | 响应信息,成功状态下为 null,失败状态下为具体错误信息 |
data | 用户 token |
示例
json
{
"code": 200,
"msg": null,
"data": "b2f57719-8d4a-4822-8255-b14f3e3d2339" // Token值
}