OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
username | String | Required | MIN: 1;MAX: 50 | 会员账号,开发者应用的会员,非开发者自己账号。进入会员列表可查看自己的应用会员。 | |
password | String | Required | MIN: 32;MAX: 32 | MD5后的密码,须md5后传递,保持全部小写,MD5加密工具 | |
is_allow_many | Boolean | Optaion | true | 是否允许多设备同时登录,true/yes/1 表示:是,false/no/0 表示:否,不允许时会注销已登录的会话状态。 | |
client | String | Optaion | MAX: 30 | 客户端,可用于纪录登录时的设备、版本或应用信息 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
username | *Required | |
password | *Required | |
is_allow_many | Option | |
client | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0登录成功,1登录失败,账号不存在;2登录失败,密码错误;3会员已过期,请联系管理员或开发者;4账号已被封号 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
uuid | String | 全局唯一UUID,全局唯一用户ID |
token | String | 登录凭证,一个月内有效 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |