跳至内容
中消云物联网研究院
用户工具
登录
站点工具
搜索
工具
显示页面
修订记录
反向链接
最近更改
媒体管理器
网站地图
登录
>
wiki:v_interface_desp_old
本页面只读。您可以查看源文件，但不能更改它。如果您觉得这是系统错误，请联系管理员。
<h3><span style="font-size:16px;"><span style="font-family: 黑体;"></span></span><div><span style="font-family: 黑体; font-weight: 700;"><span style="font-size:16px;">[[wiki:oldhome|返回]]</span></span><br /></div></h3><h3><span style="font-family: 黑体; font-size: 14pt;">1.API_TOKEN说明</span></h3><p><span style="font-family: 宋体; font-size: 10.5pt;">API_TOKEN（简称<span style="font-family: Calibri;">token</span>）</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">是</span></span><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">本平台</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">的全局唯一接口调用凭据，</span></span><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">在</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">调用各接口时都需</span></span><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">将</span><span style="font-family: 宋体; font-size: 10.5pt;">API_TOKEN</span><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">放入header存储关于</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">。开发者需要进行妥善保存。</span></span><span style="font-family: 宋体; font-size: 10.5pt;">API_TOKEN</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">的存储至少要保留</span></span><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">100</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">个字符空间。</span></span><span style="font-family: 宋体; font-size: 10.5pt;">API_TOKEN</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">的有效期</span></span><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">为长期有效</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">，重复获取将导致上次获取的</span></span><span style="font-family: 宋体; font-size: 10.5pt;">API_TOKEN</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">失效。</span></span></p><p><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;">API<span style="font-family: 宋体;">调用所需的</span></span><span style="font-family: 宋体; font-size: 10.5pt;">API_TOKEN</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">的使用及生成方式说明：</span></span></p><p><span style="font-family: 宋体; font-size: 10.5pt;">建议开发者使用中控服务器统一获取和刷新API_TOKEN，其他业务逻辑服务器所使用的<span style="font-family: Calibri;">API_TOKEN</span>均来自于该中控服务器，不应该各自去刷新，否则容易造成冲突，导致<span style="font-family: Calibri;">API_TOKEN</span>覆盖而影响业务；</span></p><p><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">开发者</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">可以使用</span>appkey<span style="font-family: 宋体;">和</span>masterSecret<span style="font-family: 宋体;">调用本接口来获取</span></span><span style="font-family: 宋体; font-size: 10.5pt;">API_TOKEN</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">。</span>appkey<span style="font-family: 宋体;">和</span>masterSecret<span style="font-family: 宋体;">可</span></span><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">联系中消云</span><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;"><span style="font-family: 宋体;">获得。</span></span></p><h3><span style="font-family: 黑体; font-size: 14pt;">2.业务接口调用方法</span></h3><p><span style="font-family: 宋体; font-size: 10.5pt;">除“获取<span style="font-family: Calibri;">API_TOKEN</span>”以外其它接口均需要在<span style="font-family: Calibri;">header</span>中设置<span style="font-family: Calibri;">API_TOKEN</span>值</span></p><p><span style="font-family: 宋体; font-size: 10.5pt;">请求样例：</span></p><p><span style="font-family: Calibri;">GET http: /login/api/1.0/auth/getToken HTTP/1.1</span></p><p><span style="font-family: Calibri;">Host: //xf.tandatech.com:4433/thirdPartyApi</span></p><p><span style="font-family: Calibri;">API_TOKEN: aab8e8f2-9f5c-41c8-b370-e03e1bf2c726</span></p><p><span style="font-family: Calibri;">Cache-Control: no-cache</span></p><h3><span style="font-family: 黑体; font-size: 14pt;">3.服务器地址</span></h3><p><span style="font-family: 宋体; font-size: 10.5pt;"> 中消云提供“测试服务器”和“正式服务器”。</span></p><p><span style="font-family: 宋体;"><span style="font-size: 14px;"> </span></span><span style="font-family: 黑体; font-size: 12pt;"><strong>(1).测试服务器</strong></span></p><p><span style="font-family: 宋体; font-size: 10.5pt;"> 在开发过程中，开发者可以在测试服务器上完成开发和调试工作。</span><span style="font-family: 宋体; font-size: 10.5pt;"> </span></p><p><span style="font-family: 宋体; font-size: 10.5pt;"></span></p><p><span style="font-family:宋体;font-size:10.5pt;"><span style="font-family:宋体;"> 测试服务器地址：（暂定）</span></span></p><table border="1" cellspacing="0"><tbody><tr><td style="width:97.5500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">替换字符</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">服务器地址</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">authServerUrl</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">https</span><span style="font-family:Calibri;font-size:10.5000pt;">:</span><span style="font-family:Calibri;font-size:10.5000pt;">/</span><span style="font-family:宋体;font-size:10.5000pt;">/</span><span style="font-family:Calibri;font-size:10.5000pt;">xf.tandatech.com</span><span style="font-family:宋体;font-size:10.5000pt;">:4433/thirdPartyApi</span><span style="font-family:Calibri;font-size:10.5000pt;">/login</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:Calibri;font-size:10.5000pt;">projectServerUrl</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">https</span><span style="font-family:Calibri;font-size:10.5000pt;">:/</span><span style="font-family:宋体;font-size:10.5000pt;">/</span><span style="font-family:Calibri;font-size:10.5000pt;">xf.tandatech.com</span><span style="font-family:宋体;font-size:10.5000pt;">:4433/thirdPartyApi</span><span style="font-family:Calibri;font-size:10.5000pt;">/ThreePlaceREST</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:Calibri;font-size:10.5000pt;">testPageUrl</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">https</span><span style="font-family:Calibri;font-size:10.5000pt;">:/</span><span style="font-family:宋体;font-size:10.5000pt;">/</span><span style="font-family:Calibri;font-size:10.5000pt;">xf.tandatech.com</span><span style="font-family:宋体;font-size:10.5000pt;">:4433/thirdPartyApi</span></p></td></tr></tbody></table><br /><h4><span style="font-family: 黑体; font-size: 16px;"> (2).正式服务器</span><br /></h4><div><span style="font-family: 黑体; font-size: 12pt;"></span><h4><span style="font-family: 黑体; font-size: 12pt;"><span style="font-family: 宋体; font-size: 10.5pt;"> <span style="font-weight: normal;">第三方系统在开发完成之后，可申请获取正式服务器地址及</span></span><span style="font-weight: normal;"><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;">appkey<span style="font-family: 宋体;">和</span>masterSecret</span><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">。获取地址及参数请联系中消云。</span> </span></span></h4></div><h3><span style="font-family: 黑体; font-size: 14pt;">4.返回说明</span></h3><h4><span style="font-family: 宋体;"><span style="font-size: 14px;"> </span></span><span style="font-family: 黑体; font-size: 12pt;">(1).HTTP状态码</span></h4><h4><span style="font-family: 宋体;"><span style="font-size: 14px;"></span></span><table border="1" cellspacing="0"><tbody><tr><td style="width: 62.1pt;"><p><span style="font-family: Calibri; font-size: 10.5pt;">C</span><span style="font-family: 宋体; font-size: 10.5pt;">ode</span></p></td><td style="width: 92.15pt;"><p><span style="font-family: 宋体; font-size: 10.5pt;">描述</span></p></td><td style="width: 344.15pt;"><p><span style="font-family: 宋体; font-size: 10.5pt;">详细解释</span></p></td></tr><tr><td style="width: 62.1pt;"><p><span style="font-family: 宋体; font-size: 10.5pt;">200</span></p></td><td style="width: 92.15pt;"><p><span style="font-family: 宋体; font-size: 10.5pt;">OK</span></p></td><td style="width: 344.15pt;"><p><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;">Success!</span></p></td></tr><tr><td style="width: 62.1pt;"><p><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt; background: rgb(249, 249, 249);">400</span></p></td><td style="width: 92.15pt;"><p><span style="font-family: 宋体; font-size: 10.5pt;">参数缺失</span></p></td><td style="width: 344.15pt;"><p><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">改请求有必填项无值</span></p></td></tr><tr><td style="width: 62.1pt;"><p><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt; background: rgb(249, 249, 249);">401</span></p></td><td style="width: 92.15pt;"><p><span style="font-family: 宋体; font-size: 10.5pt;">无权限</span></p></td><td style="width: 344.15pt;"><p><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt;">没有<span style="font-family: Helvetica;">API_TOKEN</span>或请求没有权限</span></p></td></tr><tr><td style="width: 62.1pt;"><p><span style="font-family: 宋体; color: rgb(51, 51, 51); font-size: 10.5pt; background: rgb(249, 249, 249);">500</span></p></td><td style="width: 92.15pt;"><p><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;">内部服务错误</span></p></td><td style="width: 344.15pt;"><p><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt;">服务器内部出错了。请联系我们尽快解决问题。</span></p></td></tr><tr><td style="width: 62.1pt;"><p><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt; background: rgb(249, 249, 249);">502</span></p></td><td style="width: 92.15pt;"><p><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt; background: rgb(249, 249, 249);">无效代理</span></p></td><td style="width: 344.15pt;"><p><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt; background: rgb(249, 249, 249);">业务服务器下线了或者正在升级。请稍后重试。</span></p><div><span style="font-family: Helvetica; color: rgb(51, 51, 51); font-size: 10.5pt; background: rgb(249, 249, 249);"><br /></span></div></td></tr></tbody></table><span style="font-family: 黑体; font-size: 12pt;"><br /></span></h4><h4><span style="font-family: 黑体; font-size: 12pt;">(2).返回码</span></h4><div><span style="font-family: 黑体; font-size: 12pt;"></span><table border="1" cellspacing="0"><tbody><tr><td style="width:97.5500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">返回码</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">描述</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">000000</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">请求成功</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:Calibri;font-size:10.5000pt;">L02100</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">appkey无效</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:Calibri;font-size:10.5000pt;">L02201</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">appkey与</span><span style="font-family:Calibri;font-size:10.5000pt;">masterSecret</span><span style="font-family:宋体;font-size:10.5000pt;">不匹配</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">P00000</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:Helvetica;color:rgb(51,51,51);font-size:10.5000pt;">服务器内部出错了。请联系我们尽快解决问题。</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:Calibri;font-size:10.5000pt;">P00001</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;color:rgb(51,51,51);font-size:10.5000pt;">没有结果</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:Calibri;font-size:10.5000pt;">P01000</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">输入参数错误</span></p></td></tr><tr><td style="width:97.5500pt;"><p><span style="font-family:Calibri;font-size:10.5000pt;">P02001</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">获取数据没有权限</span></p></td></tr></tbody></table><br /></div><p></p>
wiki/v_interface_desp_old.txt
· 最后更改: 2020/11/14 09:55 由
admin
页面工具
显示页面
修订记录
反向链接
回到顶部
