OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| return_data | String | Optaion | 0 | 公共参数 数据返回结构，其中： return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World"}； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。 |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| return_data | Option |
API Response
| KEY | Type | Description |
|---|---|---|
| id | Int | 唯一id |
HTTP Response Code
| HTTP Status Code | Description |
|---|---|
| Http Status = 200 | Success |
| Http Status = 400 | 非法请求，参数错误 |
| Http Status = 401 | 用户未登录，或登录凭证已过期 |
| Http Status = 402 | IP已被黑名单拦截 |
| Http Status = 403 | IP未命中白名单 |
| Http Status = 404 | 接口服务不存在 |
| Http Status = 406 | 非法app_key，请核对你所在的接口域名 |
| Http Status = 407 | 当前应用已过期 |
| Http Status = 408 | 当前应用存在异常，已被封号 |
| Http Status = 409 | 签名错误 |
| Http Status = 410 | 权限不足，非系统管理员 |
| Http Status = 411 | 权限不足，应用管理员未登录 |
| Http Status = 412 | 权限不足，非应用管理员 |
| Http Status = 413 | 本月接口流量超出，已被临时冻结 |
| Http Status = 414 | 并发过高 |
| Http Status = 415 | 接口已被开发者关闭 |
| Http Status = 416 | 权限不足，个人免费版套餐无法使用专业版接口 |
| Http Status = 417 | 子应用异常，如：子应用签名错误/已过期/流量不足 |
| Http Status = 500 | 如果出现此错误，请联系技术人员处理 |