OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Optaion | MIN: 32;MAX: 32 | 登录用户的UUID,使用此管理员系列接口时,忽略此参数。 | |
token | String | Optaion | MIN: 64;MAX: 64 | 使用此管理员系列接口时,忽略此参数。 | |
model_name | String | Required | Your table Model Name | ||
admin_uuid | String | Required | MIN: 32;MAX: 32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | String | Required | MIN: 64;MAX: 64 | 管理员的会话凭证 | |
other_uuid | String | Optaion | MIN: 32;MAX: 32 | 其他UUID,为避免混淆,当管理员要修改某位会员的数据时,可通过此参数指定修改特定uuid的数据。 | |
account_field | String | Required | MIN: 1 | 账号字段名称 | |
from_account | String | Required | MIN: 1 | 转出账号,即对应account_field字段的值,必须存在且唯一 | |
to_account | String | Required | MIN: 1 | 转入账号,即对应account_field字段的值,必须存在且唯一 | |
amount_field | String | Required | MIN: 1 | 数量字段名称,此字段必须为整数类型,例如:tinyint、smallint、int、bigint等 | |
amount | Int | Required | MIN: 1 | 待转的数量,必须为整数,且为正整数,且转出账号数量充足 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
uuid | Option | |
token | Option | |
model_name | *Required | |
admin_uuid | *Required | |
admin_token | *Required | |
other_uuid | Option | |
account_field | *Required | |
from_account | *Required | |
to_account | *Required | |
amount_field | *Required | |
amount | *Required |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功;1开发类错误;2应用层规则拦截,拦截后可以小白开放平台查看日记;10转出账号不存在;11转出账号不唯一;12转出账号数量不足;20转入账号不存在;21转入账号不唯一 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
from_account_amout | Int | 成功转移后转出账号的剩余数量 |
to_account_amout | Int | 成功转移后转入账号的最新数量 |
amount | Int | 成功转移后本次转移的数量 |
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 |