API_TOKEN(简称token)是本平台的全局唯一接口调用凭据,在调用各接口时都需将API_TOKEN放入header存储关于。开发者需要进行妥善保存。API_TOKEN的存储至少要保留100个字符空间。API_TOKEN的有效期为长期有效,重复获取将导致上次获取的API_TOKEN失效。
API调用所需的API_TOKEN的使用及生成方式说明:
建议开发者使用中控服务器统一获取和刷新API_TOKEN,其他业务逻辑服务器所使用的API_TOKEN均来自于该中控服务器,不应该各自去刷新,否则容易造成冲突,导致API_TOKEN覆盖而影响业务;
开发者可以使用appkey和masterSecret调用本接口来获取API_TOKEN。appkey和masterSecret可联系中消云获得。
除“获取API_TOKEN”以外其它接口均需要在header中设置API_TOKEN值
请求样例:
GET http: /login/api/2.0/auth/getToken HTTP/1.1
Host: www.zxyun119.com/thirdPartyApi
API_TOKEN: aab8e8f2-9f5c-41c8-b370-e03e1bf2c726
Cache-Control: no-cache
替换字符 | 服务器地址 |
authServerUrl | https://www.zxyun119.com/thirdPartyApi/login |
projectServerUrl | https://www.zxyun119.com/thirdPartyApi/ThreePlaceREST |
testPageUrl | https://www.zxyun119.com/thirdPartyApi |
Code | 描述 | 详细解释 |
200 | OK | Success! |
400 | 参数缺失 | 改请求有必填项无值 |
401 | 无权限 | 没有API_TOKEN或请求没有权限 |
500 | 内部服务错误 | 服务器内部出错了。请联系我们尽快解决问题。 |
502 | 无效代理 | 业务服务器下线了或者正在升级。请稍后重试。 |
返回码 | 描述 |
000000 | 请求成功 |
L01013 | 请检查路径是否正确 |
L02100 | appkey无效 |
L02201 | appkey与masterSecret不匹配 |
P00000 | 服务器内部出错了。请联系我们尽快解决问题。 |
P00001 | 没有结果 |
P01000 | 输入参数错误 |
P02001 | 获取数据没有权限 |