OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
user_id | String | Optaion | 生成口令的淘宝用户ID,如:123 | ||
text | String | Required | MIN: 5 | 口令弹框内容,长度大于5个字符 | |
url | String | Required | 口令跳转目标页,如:https://uland.taobao.com/ | ||
logo | String | Optaion | 口令弹框logoURL | ||
ext | String | Optaion | 扩展字段JSON格式,如:{} |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
user_id | Option | |
text | *Required | |
url | *Required | |
logo | Option | |
ext | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
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 |