跳至内容
中消云物联网研究院
用户工具
登录
站点工具
搜索
工具
显示页面
修订记录
反向链接
最近更改
媒体管理器
网站地图
登录
>
wiki:v_interface_desp
本页面只读。您可以查看源文件,但不能更改它。如果您觉得这是系统错误,请联系管理员。
<h3><strong><span style="font-family:黑体;font-size:14pt;">1.API_TOKEN说明</span></strong></h3><p><span style="font-family:宋体;font-size:10.5000pt;">API_TOKEN<span style="font-family:宋体;">(简称</span><span style="font-family:Calibri;">token</span><span style="font-family:宋体;">)</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 style="font-family:宋体;">本平台</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 style="font-family:宋体;">在</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 style="font-family:宋体;">将</span></span><span style="font-family:宋体;font-size:10.5000pt;">API_TOKEN</span><span style="font-family:宋体;color:rgb(51, 51, 51);font-size:10.5pt;"><span style="font-family:宋体;">放入</span>header<span style="font-family:宋体;">存储关于</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:宋体;font-size:10.5000pt;">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.5000pt;">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 style="font-family:宋体;">为长期有效</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:宋体;font-size:10.5000pt;">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.5000pt;">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.5000pt;"><span style="font-family:宋体;">建议开发者使用中控服务器统一获取和刷新</span>API_TOKEN<span style="font-family:宋体;">,其他业务逻辑服务器所使用的</span><span style="font-family:Calibri;">API_TOKEN</span><span style="font-family:宋体;">均来自于该中控服务器,不应该各自去刷新,否则容易造成冲突,导致</span><span style="font-family:Calibri;">API_TOKEN</span><span style="font-family:宋体;">覆盖而影响业务;</span></span></p><p><span style="font-family:宋体;color:rgb(51, 51, 51);font-size:10.5pt;"><span style="font-family:宋体;">开发者</span></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><span style="font-family:Helvetica;">masterSecret</span><span style="font-family:宋体;">调用本接口来获取</span></span><span style="font-family:宋体;font-size:10.5000pt;">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><span style="font-family:Helvetica;">masterSecret</span><span style="font-family:宋体;">可</span></span><span style="font-family:宋体;color:rgb(51, 51, 51);font-size:10.5pt;"><span style="font-family:宋体;">联系中消云</span></span><span style="font-family:Helvetica;color:rgb(51, 51, 51);font-size:10.5pt;"><span style="font-family:宋体;">获得。</span></span></p><h3><strong><span style="font-family:黑体;font-size:14pt;"><span style="font-family:黑体;">2.业务接口调用方法</span></span></strong></h3><p><span style="font-family:宋体;font-size:10.5000pt;"><span style="font-family:宋体;">除</span>“获取<span style="font-family:Calibri;">API_TOKEN</span><span style="font-family:宋体;">”以外其它接口均需要在</span><span style="font-family:Calibri;">header</span><span style="font-family:宋体;">中设置</span><span style="font-family:Calibri;">API_TOKEN</span><span style="font-family:宋体;">值</span></span></p><p><span style="font-family:宋体;font-size:10.5000pt;"><span style="font-family:宋体;">请求样例:</span></span></p><p><span style="font-family: Calibri;"><span style="font-size:12px;">GET http: /login/api/2.0/auth/getToken HTTP/1.1</span></span></p><p><span style="font-family: Calibri;"><span style="font-size:12px;">Host: //www.zxyun119.com/thirdPartyApi</span></span></p><p><span style="font-family: Calibri;"><span style="font-size:12px;">API_TOKEN: aab8e8f2-9f5c-41c8-b370-e03e1bf2c726</span></span></p><p><span style="font-family: Calibri;"><span style="font-size:12px;">Cache-Control: no-cache</span></span></p><h3><strong><span style="font-family:黑体;font-size:14pt;"><span style="font-family:黑体;">3.服务器地址</span></span></strong><span style="font-family:宋体;"> </span><span style="font-size: 12px; font-family: 宋体;"><span style="font-size: 14px;"> </span></span></h3><h4><span style="font-weight: bold;"><span style="font-family:黑体;font-size:12pt;"><span style="font-family:黑体;"></span></span></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;">authServerUrl</span></p></td><td style="width:400.8500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;"></span><span style="font-weight: 700; font-family: 宋体; font-size: 10.5pt;">https</span><span style="font-weight: 700; font-family: Calibri; font-size: 10.5pt;">:<span style="font-size: 10.5pt;">/</span><span style="font-family: 宋体; font-size: 10.5pt;">/</span>www.zxyun119.com</span><span style="font-weight: 700; font-family: 宋体; font-size: 10.5pt;">/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;"></span><span style="font-weight: 700; font-family: 宋体; font-size: 10.5pt;">https</span><span style="font-weight: 700; font-family: Calibri; font-size: 10.5pt;">:<span style="font-size: 10.5pt;">/</span><span style="font-family: 宋体; font-size: 10.5pt;">/</span>www.zxyun119.com</span><span style="font-weight: 700; font-family: 宋体; font-size: 10.5pt;">/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;"></span><span style="font-weight: 700; font-family: 宋体; font-size: 10.5pt;">https</span><span style="font-weight: 700; font-family: Calibri; font-size: 10.5pt;">:<span style="font-size: 10.5pt;">/</span><span style="font-family: 宋体; font-size: 10.5pt;">/</span>www.zxyun119.com</span><span style="font-weight: 700; font-family: 宋体; font-size: 10.5pt;">/<span style="font-family: 宋体; font-size: 14px; font-weight: 700;">thirdPartyApi</span></span><br /><span style="font-size: 10.5pt;"><span style="font-family:Calibri;"></span></span></p></td></tr></tbody></table></h4><h4><span style="font-family: 黑体; font-size: 16px;"> </span> </h4><h3><strong><span style="font-family:黑体;font-size:14pt;"><span style="font-family:黑体;">4.返回说明</span></span></strong></h3><h2><span style=" font-family: 黑体; font-size: 12pt;"><strong> </strong></span><span style="font-family: 黑体;"><span style="font-size:16px;">(1).HTTP状态码</span></span></h2><table border="1" cellspacing="0"><tbody><tr><td style="width:62.1000pt;"><p><span style="font-family:Calibri;font-size:10.5000pt;">C</span><span style="font-family:宋体;font-size:10.5000pt;">ode</span></p></td><td style="width:92.1500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">描述</span></p></td><td style="width:344.1500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">详细解释</span></p></td></tr><tr><td style="width:62.1000pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">200</span></p></td><td style="width:92.1500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">OK</span></p></td><td style="width:344.1500pt;"><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.1000pt;"><p><span style="font-family:Helvetica;color:rgb(51,51,51);font-size:10.5000pt;background:rgb(249,249,249);">400</span></p></td><td style="width:92.1500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">参数缺失</span></p></td><td style="width:344.1500pt;"><p><span style="font-family:宋体;color:rgb(51, 51, 51);font-size:10.5pt;">改请求有必填项无值</span></p></td></tr><tr><td style="width:62.1000pt;"><p><span style="font-family:宋体;color:rgb(51,51,51);font-size:10.5000pt;background:rgb(249,249,249);">401</span></p></td><td style="width:92.1500pt;"><p><span style="font-family:宋体;font-size:10.5000pt;">无权限</span></p></td><td style="width:344.1500pt;"><p><span style="font-family:宋体;color:rgb(51, 51, 51);font-size:10.5pt;">没有<span style="font-family:Helvetica;">API_TOKEN</span><span style="font-family:宋体;">或请求没有权限</span></span></p></td></tr><tr><td style="width:62.1000pt;"><p><span style="font-family:宋体;color:rgb(51,51,51);font-size:10.5000pt;background:rgb(249,249,249);">500</span></p></td><td style="width:92.1500pt;"><p><span style="font-family:Helvetica;color:rgb(51, 51, 51);font-size:10.5pt;">内部服务错误</span></p></td><td style="width:344.1500pt;"><p><span style="font-family:Helvetica;color:rgb(51, 51, 51);font-size:10.5pt;">服务器内部出错了。请联系我们尽快解决问题。</span></p></td></tr><tr><td style="width:62.1000pt;"><p><span style="font-family:Helvetica;color:rgb(51,51,51);font-size:10.5000pt;background:rgb(249,249,249);">502</span></p></td><td style="width:92.1500pt;"><p><span style="font-family:Helvetica;color:rgb(51,51,51);font-size:10.5000pt;background:rgb(249,249,249);">无效代理</span></p></td><td style="width:344.1500pt;"><p><span style="font-family:Helvetica;color:rgb(51,51,51);font-size:10.5000pt;background:rgb(249,249,249);">业务服务器下线了或者正在升级。请稍后重试。</span></p></td></tr></tbody></table><h4></h4><h2><span style="font-family: 黑体; font-size: 12pt;"> </span><span style="font-family: 黑体;"><span style="font-size:16px;">(2).返回码</span></span></h2><p></p><table border="1" cellspacing="0"><tbody><tr><td style="width:85.05pt;"><p><span style="font-family:宋体;font-size:10.5pt;">返回码</span></p></td><td style="width:332.5pt;"><p><span style="font-family:宋体;font-size:10.5pt;">描述</span></p></td></tr><tr><td style="width:85.05pt;"><p><span style="font-family:宋体;font-size:10.5pt;">000000</span></p></td><td style="width:332.5pt;"><p><span style="font-family:宋体;font-size:10.5pt;">请求成功</span></p></td></tr><tr><td style="width:85.05pt;"><p><span style="font-family:宋体;font-size:10.5pt;">L01013</span></p></td><td style="width:332.5pt;"><p><span style="font-family:宋体;font-size:10.5pt;">请检查路径是否正确</span></p></td></tr><tr><td style="width:85.05pt;"><p><span style="font-family:Calibri;font-size:10.5pt;">L02100</span></p></td><td style="width:332.5pt;"><p><span style="font-family:宋体;font-size:10.5pt;">appkey<span style="font-family:宋体;">无效</span></span></p></td></tr><tr><td style="width:85.05pt;"><p><span style="font-family:Calibri;font-size:10.5pt;">L02201</span></p></td><td style="width:332.5pt;"><p><span style="font-family:宋体;font-size:10.5pt;">appkey<span style="font-family:宋体;">与</span></span><span style="font-family:Calibri;font-size:10.5pt;">masterSecret</span><span style="font-family:宋体;font-size:10.5pt;">不匹配</span></p></td></tr><tr><td style="width:85.05pt;"><p><span style="font-family:宋体;font-size:10.5pt;">P00000</span></p></td><td style="width:332.5pt;"><p><span style="font-family:Calibri;font-size:10.5pt;">服务器内部出错了。请联系我们尽快解决问题。</span></p></td></tr><tr><td style="width:85.05pt;"><p><span style="font-family:Calibri;font-size:10.5pt;">P00001</span></p></td><td style="width:332.5pt;"><p><span style="font-family:宋体;font-size:10.5pt;">没有结果</span></p></td></tr><tr><td style="width:85.05pt;"><p><span style="font-family:Calibri;font-size:10.5pt;">P01000</span></p></td><td style="width:332.5pt;"><p><span style="font-family:宋体;font-size:10.5pt;">输入参数错误</span></p></td></tr><tr><td style="width:85.05pt;"><p><span style="font-family:Calibri;font-size:10.5pt;">P02001</span></p></td><td style="width:332.5pt;"><p><span style="font-family:宋体;font-size:10.5pt;">获取数据没有权限</span></p></td></tr></tbody></table><p></p>
wiki/v_interface_desp.txt
· 最后更改: 2023/09/08 06:30 由
admin
页面工具
显示页面
修订记录
反向链接
回到顶部