人員賬號服務API
1. 概述
創建人員統一身份id(identifyID)
2. 接口定義
2.1 注銷賬號
路徑 | /user/account/unregister |
版本號 | 1.0.1 |
協議 | HTTPS |
請求方法 | POST |
授權類型 | app簽名 |
超時時間 | 3000 |
請求參數
名稱 | 類型 | 是否必選 | 描述 |
identityId | String | 是 | 需要注銷的統一身份ID。 |
返回數據
名稱 | 類型 | 描述 |
code | Int | 接口返回碼。200表示成功。 |
message | String | 調用失敗時,返回的出錯信息。 |
localizedMsg | String | 本地語言的錯誤消息。 |
示例
請求示例:
// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");
SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
IoTApiRequest request = new IoTApiRequest();
// 設置請求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 設置API版本號
request.setApiVer("1.0.1");
// 設置參數
request.putParam("identityId","value1");
// 如果需要,設置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");
// 設置請求參數域名、path、request , isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/user/account/unregister", request, true, headers);
System.out.println(
"response code = " + response.getCode()
+ " response = " + new String(response.getBody(), "UTF-8")
+ " headers = " + response.getHeaders().toString()
);
正常返回示例:
{
"id": "8d1a665e-ce92-45bf-add8-99d2e818****",
"code": 200,
"message": null,
"localizedMsg": null,
"data": ""
}
異常返回示例:
{
"id": "8d1a665e-ce92-45bf-add8-99d2e818****",
"code": 460,
"message": "identityId is blank!",
"localizedMsg": null,
"data": null
}
錯誤碼:
錯誤碼 | 錯誤信息 | 錯誤描述 |
460 | identityId is blank | 需要注銷的賬號不存在。 |
2.2 賬號注冊
路徑 | /user/account/register |
版本號 | 1.0.2 |
協議 | HTTPS |
請求方法 | POST |
授權類型 | app簽名 |
超時時間 | 3000 |
請求參數
名稱 | 類型 | 是否必選 | 描述 |
loginName | String | 是 | 登錄名 |
phone | String | 否 | 手機號 |
String | 否 | 郵件地址 | |
nickName | String | 是 | 用戶昵稱 |
password | String | 否 | 密碼 |
avatarUrl | String | 否 | 頭像url |
creater | String | 否 | 創建者 |
mobileLocationCode | String | 否 | 手機國際區號 |
返回數據
名稱 | 類型 | 描述 |
code | Int | 接口返回碼。200表示成功。 |
message | String | 調用失敗時,返回的出錯信息。 |
localizedMsg | String | 本地語言的錯誤消息。 |
data | String | 統一身份identityId,即為創建員工的accountId。 |
示例
請求示例:
// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");
SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
IoTApiRequest request = new IoTApiRequest();
// 設置請求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 設置API版本號
request.setApiVer("1.0.2");
// 設置參數
request.putParam("loginName","value1");
request.putParam("phone","value2");
request.putParam("email","value3");
request.putParam("nickName","value4");
request.putParam("password","value5");
request.putParam("avatarUrl","value6");
request.putParam("creater","value7");
request.putParam("mobileLocationCode","value8");
// 如果需要,設置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");
// 設置請求參數域名、path、request , isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/user/account/register", request, true, headers);
System.out.println(
"response code = " + response.getCode()
+ " response = " + new String(response.getBody(), "UTF-8")
+ " headers = " + response.getHeaders().toString()
);
正常返回示例:
{
"id": "f1ed2f40-a02e-4b20-a691-21bc3cb17707",
"code": 200,
"message": null,
"localizedMsg": null,
"data": "505fop357f0d8299b92664fc91012ae88ed25269"
}
異常返回示例:
{
"id": "f1ed2f40-a02e-4b20-a691-21bc3cb17707",
"code": 2404,
"message": "手機格式不正確",
"localizedMsg": null,
"data": null
}
錯誤碼
錯誤碼 | 錯誤信息 | 錯誤描述 |
2402 | registerAccount failed | 賬號注冊失敗 |
2404 | oa error message | 手機號格式不正確 |
2.3 賬號凍結
路徑 | /user/account/freeze |
版本號 | 1.0.1 |
協議 | HTTPS |
請求方法 | POST |
授權類型 | app簽名 |
超時時間 | 3000 |
請求參數
名稱 | 類型 | 是否必選 | 描述 |
identityId | String | 是 | 統一身份id |
返回數據
名稱 | 類型 | 描述 |
code | Int | 接口返回碼。200表示成功。 |
message | String | 調用失敗時,返回的出錯信息。 |
localizedMsg | String | 本地語言的錯誤消息。 |
示例
請求示例:
// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");
SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
IoTApiRequest request = new IoTApiRequest();
// 設置請求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 設置API版本號
request.setApiVer("1.0.1");
// 設置參數
request.putParam("identityId","value1");
// 如果需要,設置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");
// 設置請求參數域名、path、request , isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/user/account/freeze", request, true, headers);
System.out.println(
"response code = " + response.getCode()
+ " response = " + new String(response.getBody(), "UTF-8")
+ " headers = " + response.getHeaders().toString()
);
正常返回示例:
{
"id": "8d1a665e-ce92-45bf-add8-99d2e81814f3",
"code": 200,
"message": null,
"localizedMsg": null,
"data": ""
}
異常返回示例:
{
"id": "8d1a665e-ce92-45bf-add8-99d2e81814f3",
"code": 460,
"message": "identityId is blank!",
"localizedMsg": null,
"data": null
}
錯誤碼
錯誤碼 | 錯誤信息 | 錯誤描述 |
460 | identityId is blank | 凍結的賬號不存在 |
2.4 賬號解凍
路徑 | /user/account/unfreeze |
版本號 | 1.0.0 |
協議 | HTTPS |
請求方法 | POST |
授權類型 | app簽名 |
超時時間 | 3000 |
請求參數
名稱 | 類型 | 是否必選 | 描述 |
identityId | String | 是 | 統一身份id |
返回數據
名稱 | 類型 | 描述 |
code | Int | 接口返回碼。200表示成功。 |
message | String | 調用失敗時,返回的出錯信息。 |
localizedMsg | String | 本地語言的錯誤消息。 |
示例
請求示例:
// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");
SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
IoTApiRequest request = new IoTApiRequest();
// 設置請求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 設置API版本號
request.setApiVer("1.0.0");
// 設置參數
request.putParam("identityId","value1");
// 如果需要,設置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");
// 設置請求參數域名、path、request , isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/user/account/unfreeze", request, true, headers);
System.out.println(
"response code = " + response.getCode()
+ " response = " + new String(response.getBody(), "UTF-8")
+ " headers = " + response.getHeaders().toString()
);
正常返回示例:
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null
}
異常返回示例:
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "請求被禁止"
}
錯誤碼
錯誤碼 | 錯誤信息 | 錯誤描述 |
403 | request forbidden. | 請求被禁止 |
2.5 根據手機號查找賬號信息
路徑 | /user/account/querybyphone |
版本號 | 1.0.1 |
協議 | HTTPS |
請求方法 | POST |
授權類型 | app簽名 |
超時時間 | 3000 |
請求參數
名稱 | 類型 | 是否必選 | 描述 |
phone | String | 是 | 手機號 |
返回數據
名稱 | 類型 | 描述 |
code | Int | 接口返回碼。200表示成功。 |
message | String | 調用失敗時,返回的出錯信息。 |
localizedMsg | String | 本地語言的錯誤消息。 |
data | JSON | 響應結果 |
響應結果 data:
名稱 | 類型 | 描述 |
identityId | String | 賬號id |
loginId | String | openaccount Id |
loginName | String | 登錄名 |
phone | String | 手機號 |
String | 郵箱地址 | |
nickName | String | 昵稱 |
creater | String | 創建者 |
modifier | String | 修改者 |
createAppKey | String | 創建appkey |
avatarUrl | String | 頭像地址 |
phoneLocationCode | String | 手機號國家區號 |
示例
請求示例:
// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();
ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");
SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);
IoTApiRequest request = new IoTApiRequest();
// 設置請求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 設置API版本號
request.setApiVer("1.0.1");
// 設置參數
request.putParam("phone","value1");
// 如果需要,設置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");
// 設置請求參數域名、path、request , isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/user/account/querybyphone", request, true, headers);
System.out.println(
"response code = " + response.getCode()
+ " response = " + new String(response.getBody(), "UTF-8")
+ " headers = " + response.getHeaders().toString()
);
正常返回示例:
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"createAppKey": "25214645",
"creater": "鄭士林",
"identityId": "50b7op6575e3453gd345290b4aa7480174495",
"loginId": "27921931",
"nickName": "abc",
"phone": "180274*****"
}
}
異常返回示例:
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "請求被禁止",
"data": null
}
錯誤碼
錯誤碼 | 錯誤信息 | 錯誤描述 |
403 | request forbidden. | 請求被禁止 |