OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| page | Int | Optaion | 1 | MIN: 1 | 页数 |
| perpage | Int | Optaion | 20 | MIN: 1；MAX: 200 | 分页数量 |
| sort_type | Int | Optaion | 1 | 排序类型，1是按创建时间降序，2是按访问次数降序 | |
| search | String | Optaion | 模糊搜索标题或短链接代码 |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| page | Option | |
| perpage | Option | |
| sort_type | Option | |
| search | Option |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景 |
| err_msg | String | 错误提示信息，err_code非0时参考此提示信息 |
| items | Array | 短链接列表 |
| items[].title | String | 短链接标题 |
| items[].code | String | 短链接代码 |
| items[].url | String | 完整原始链接 |
| items[].add_time | String | 添加时间 |
| items[].visit_times | Int | 访问次数 |
| items[].short_url | String | 短链接 |
| total | 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 |