用户注册
1.描述: 用户进行注册
2.接口地址:
请求路径:
/ws-rest/v1/users
请求头:
采用HMAC认证
请求体:
{ "accountName": "13812344321", "password": "cd1b8ecf103743a98958211a11e33b71", "realName": "\u674e\u4f1f", "registFrom": 1, "registType": 1, "role": "BASIC", "activateNow": true }
3.请求方式
POST
4.请求参数说明
a.请求示例
curl -X POST \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Date: Wed, 02 Nov 2016 03:25:54 GMT" \
--header "User-Agent: SignIt RestAPI Client v1.0.0" \
--header "Host: api.signit.cn" \
--header "Authorization:HmacSHA512 a1S0H2-U0-v5I-0586-017-z6D-7B5-K0h-1o0-G0-9923G3Xm:53f7ae4a-937b-4ddc-8872-42dd094d56eb:NCMwvHfZS9ZzB2SgVbRzTuS/N5yDRM8Ak6tRvCavHD5T9nKjydc9ha+Rj48e0YIFC5V9IRtFL8Z1d0hvse7Ulg==" \
-d \
"{
\"accountName\": \"[email protected]\",
\"password\": \"cd1b8ecf103743a98958211a11e33b71\",
\"realName\": \"\u674e\u4f1f\",
\"registFrom\": 1,
\"registType\": 1,
\"role\": \"BASIC\",
\"activateNow\": true
}" \
"http://api.signit.cn/ws-rest/v1/users"
b.请求字段说明
字段 | 必填 | 类型 | 位置 | 长度 | 说明 |
---|---|---|---|---|---|
accountName | 是 | String | BODY | 手机号/邮箱等唯一值 | |
password | 是 | Sting | BODY | 经过MD5加密6-50位任意字符串后的十六进制小写表示的值 | |
realName | 是 | String | BODY | 用户真实姓名,采用unicode编码,如:\u674e\u4f1f(李伟) | |
registFrom | 是 | int | BODY | 注册来源:1(WEB),2(PC客户端),3(安卓),4(IOS),5(第三方平台) | |
registType | 是 | int | BODY | 注册方式:1(手机注册方式),2(邮箱注册方式) | |
role | 否 | String | BODY | 用户注册角色,BASIC(基本类型),STANDARD(标准类型),BUSINESS(商业类型),若不填,默认:BASIC | |
activateNow | 否 | Boolean | BODY | 是否立即激活账户,默认值:false |
5.响应参数说明
a.响应示例
- 响应成功:
{ "resultStatusCode": "100230000", "resultCode": 0, "resultDesc": "\u64cd\u4f5c\u6210\u529f", "userId": 1868, "userLink": { "opened": true, "desc": "new user resources", "rel": "users", "href": "/ws-rest/v1/users/1868", "method": "GET" }, "activateLink": { "opened": true, "desc": "activate your new account", "rel": "phone", "href": "/ws-rest/v1/common/phone/send", "method": "POST" } }
- 响应失败:
{ "resultStatusCode": "100230106", "resultCode": 1, "resultDesc": "\u6821\u9a8c\u53e3\u4ee4\u5931\u8d25" }
b.响应字段说明
字段 | 必填 | 类型 | 位置 | 长度 | 说明 |
---|---|---|---|---|---|
resultStatusCode | 是 | string | BODY | 固定值 | 结果状态码 |
resultCode | 是 | int | BODY | 固定值-0,1 | 结果码,0-成功,1-失败,具体含义见结果状态码 |
resultDesc | 是 | string | BODY | 无 | 操作结果说明,见其包含信息 |
userId | 是 | number | BODY | 无 | 新注册的用户ID |
activateLink | 是 | OBJECT | BODY | 激活用户链接,见其包含信息 | |
open | 是 | string | BODY | 代表当前资源访问是否已经开放。true - 开放访问;false - 禁止访问 | |
desc | 是 | string | BODY | 提示信息 | |
rel | 是 | string | BDOY | 当前资源需要引用的链接名称 | |
href | 是 | string | BODY | 激活账户链接 | |
method | 是 | string | BODY | 服务器交互方法 | |
userLink | 是 | OBJECT | BODY | 用户登录链接,见其包含信息 | |
open | 是 | string | BODY | 代表当前资源访问是否已经开放。true - 开放访问;false - 禁止访问 | |
desc | 是 | string | BOYD | 提示信息 | |
rel | 是 | string | BODY | 当前资源需要引用的链接名称 | |
href | 是 | string | BODY | 激活账户链接 | |
method | 是 | string | BOYD | 服务器交互方法 |