1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/appapi
。
本接口(AppGetToken)用于手机号码、邮箱账号登录,获取用户访问 Token。2. 输入参数
名称 | 类型 | 必选 | 描述 |
Action | String | 是 | 公共参数,本接口取值:AppGetToken。 |
RequestId | String | 是 | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuid。定位问题时,需提供该次请求的 RequestId。 |
AppKey | String | 是 | 公共参数,应用 AppKey ,用于标识对应的 App。 |
Signature | String | 是 | 公共参数,请求签名,需用户自行生成,用于校验请求的合法性。 |
Timestamp | Int64 | 是 | 公共参数,请求的 Unix 时间戳(秒级)。 |
Nonce | Int | 是 | 公共参数,随机正整数,与 Timestamp 联合起来,防止重放攻击。 |
Type | String | 否 | 账号类型。 phone:手机号。 email:邮箱。 |
CountryCode | String | 否 | 国家号。 |
PhoneNumber | String | 否 | 手机号。 |
Email | String | 否 | 邮箱。 |
Password | String | 是 | 登录密码。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。 |
Data | String | 响应结果。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/appapi HTTP/1.1content-type: application/json{"Email": "test@example","Password": "123456","Type": "email","Signature": "w2kTSOU7IKc2aJ+UplV34VHp1RI=","Timestamp": 1552621825,"Nonce": 2,"Action": "AppGetToken","AppKey": "ahPxdK*****TGrejd","RequestId": "rest-client"}
输出示例:成功
{"Response": {"Data": {"ExpireAt": 1556076201,"Token": "d2******************8514"},"RequestId": "rest-client"}}
输出示例:失败
{"Response": {"Error": {"Code": "InternalError","Message": "InvalidParameterValue.UserLoginFailed|用户登录失败"},"RequestId": "rest-client"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
ErrorRequiredParamNotFound | 必选参数缺失。 |
InvalidAction | Action 非法。 |
InvalidParameterValue | 参数非法。 |
InvalidParameterValue.InvalidJSON | 请求格式不是 JSON。 |
InvalidParameterValue.UserLoginFailed | 用户登录失败。 |
InvalidParameterValue.UserLoginForbidden | 账号被锁定。 |