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,全局唯一用户ID | |
token | String | Optaion | MIN: 64;MAX: 64 | 会话凭证 | |
other_uuid | String | Required | MIN: 32;MAX: 32 | 游客针对的UUID,全局唯一用户ID | |
id | Int | Required | MIN: 1 | 元素ID | |
data | ArrayJSON Format | Required | 增量更新的元素数据,需要JSON编码后传递。JSON在线解析及格式化验证 | ||
keyword | String | Optaion | MAX: 100 | 待更新的关键字,为空时删除关键字 | |
weight | String | Optaion | 待更新的权重 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
uuid | Option | |
token | Option | |
other_uuid | *Required | |
id | *Required | |
data | *Required | |
keyword | Option | |
weight | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0更新成功,1元素不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
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 |