接口规范

通信协议

柠檬云使用经过加密http协议(https)进行通讯

参数传递

querystring方式传递请将相关的内容编码传递,否则可能出现不可预期问题
body传值方式默认为json

接口风格

绝大部分接口遵循restful风格

状态码

  • 同http状态码含义一致
  • 自定义状态码,具体可以查看相应系统返回的业务状态码

部分错误码对照表

编码 说明
11010101 无效的appId
11010201 错误的appSecret
11020101 请求次数超过限制
31010102 access_token错误
31010103 非法的orgId
41010201 非法的组织机构名称。组织机构名称不能为空或超过32个中英文字
71010201 非法的userId或者userId不能为空
71010202 此userId已注册
71010301 老密码不正确
71010401 新密码不正确
71010701 非法邮箱
71010702 非法邮箱
71010801 参数不可为空
810104401 手机号为空或者格式不正确
810104501 手机号已存在
810105501 手机验证码错误
11010102 调用频率超过限制
100 错误的请求协议
101 错误的请求方法
102 未找到 access_token
104 apikey 不存在或已删除
105 apikey 已被禁用
106 access_token 已过期
107 请求地址未注册
108 用户未授权访问此数据
109 apikey 未申请此权限
110 未注册的测试用户
111 用户访问速度限制
112 IP 访问速度限制
113 缺少参数
114 错误的 grant_type
115 错误的 response_type
116 client_secret不匹配
117 redirect_uri不匹配
118 authorization_code 不存在或已过期
119 refresh_token 不存在或已过期
120 用户名密码不匹配
121 用户不存在或已删除
122 用户已被屏蔽
123 因用户修改密码而导致 access_token 过期
124 access_token 未过期
125 访问的 scope 不合法,开发者不用太关注,一般不会出现该错误
126 访问来源不合法
127 第三方授权错误