1.1权限校验

<< Click to Display Table of Contents >>

当前位置:  部署与集成 > WebAPI 

1.1权限校验

复制链接

请求地址

http://ip:port/bi/api?action=login&adminv=xxxx&passv=xxxx

注意:

URL登录时,密码不可设置为特殊字符“"”和“<”,其他特殊字符需要转义登录。

权限验证返回的token代表一个http session,不需要每次调用API时都调用这个接口。token的失效时间由属性:secure.session.timeout=1800000的值控制,单位为秒,默认失效时间为30分钟。

最后一定要调用【1.2退出权限】接口,否则可能会导致短期内出现用户数过多,无法权限验证的情况。并且此接口只是用来进行api验证用,不能用来进行单点登录。

请求消息

请求参数

无xml请求参数

参数描述

请求参数只在url上添加adminv和passv即可,分别对应要权限验证的用户名和密码。

示例

function login() {

 $.post("http://" + ip + ":" + port + "/" + project + "/api?       action=login&adminv=admin&passv=g5",

  {},

  function(result) {

     writeXml(result);

  });

}

响应消息

响应结果

权限验证成功

<results>

  <result>

     <level>1</level>

     <message>5B9778881E30396DF314B1F58AF20597</message>

  </result>

</results>

权限验证失败

<results>

  <result>

     <level>6</level>

     <message>用户名或密码错误。</message>

  </result>

</results>

结果描述

响应结果信息为xml,直接parse即可。

level 返回类型,不同数值代表不同返回状态,见附录

message为接口操作结果信息。当level为1时,表示权限验证成功,message信息为token值;当level为6时,表示权限验证失败,message信息为失败原因。以下所有接口在请求时都需要带上token信息。