OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| uuid | String | Required | MIN: 32；MAX: 32 | UUID，全局唯一用户ID | |
| token | String | Required | MIN: 64；MAX: 64 | 会话凭证 |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| uuid | *Required | |
| token | *Required |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作码，０正常获取，1用户不存在，或者已被封号 |
| err_msg | String | 错误提示信息，err_code非0时参考此提示信息 |
| info.uuid | String | 全局唯一UUID，全局唯一用户ID，注册成功时返回 |
| info.username | String | 账号/昵称 |
| info.role | String | 用户角色（user/admin） |
| info.rolename | String | 用户角色说明（普通用户/管理员） |
| info.register_time | String | 注册时间，示例：2018-01-20 15:00:00 |
| info.register_ip | String | 注册IP，示例：192.168.1.1 |
| info.ext_info | Object | 用户扩展信息，开发者可以自定义存放更多用户信息，如：昵称、头像、年龄、性别等。以yesapi_开头的扩展字段，属于小白开放平台维护的信息。其中，yesapi_avatar是会员头像链接，yesapi_avatar_https则表示HTTPS的头像链接（不支持时为空）。 |
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 |