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,欢迎使用小白开放接口!"}。 | |
username | String | Required | MIN: 6;MAX: 10 | 注册成为应用的会员账号,注册后不可修改。 | |
password | String | Required | MIN: 6;MAX: 10 | MD5后的密码,须md5后传递,保持全部小写,MD5加密工具 | |
ext_info | Array | Optaion | 注册时的用户扩展信息,注册后可修改,需要JSON编码后传递。格式:ext_info={"扩展字段名":"值"},可以同时更新多个字段。JSON在线解析及格式化验证 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
return_data | Option | |
username | *Required | |
password | *Required | |
ext_info | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0注册成功,1已注册,-1可用注册人数已用完 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
uuid | String | 全局唯一UUID,全局唯一用户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 | 如果出现此错误,请联系技术人员处理 |