页面树结构

版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

示例代码请参考: DemoCodeDemoCode  、 示例程序下载 

4.

...

4.1.1 接口说明

...

1 登录AIChat

  • 接口说明

名称

请求地址

http://smartbi-AIChat-server:port/aiweb/api/v1/login

请求方式

POST

请求参数

userName

password

smartbiServer

casLoginUrl

loginMethod

...

  • 接口参数说明


URL参数名

说明

是否必填

输入参数

userName

登录账号

必填

password

登录密码

必填

smartbiServer

Smartbi服务器地址;该AIChat服务器第一次登录Smartbi,必填;以后选填;不填则使用之前已经登录过的Smartbi服务器

Smartbi服务器地址。该AIChat服务器第一次登录Smartbi,必填;以后选填;不填则使用之前已经登录过的Smartbi服务器。

选填

casLoginUrl

如果Smartbi是使用CAS登录方式,则需要填入该值;该AIChat服务器第一次登录Smartbi,必填;以后选填;不填则使用之前已经登录过的Cas认证服务器

如果Smartbi是使用CAS登录方式,则需要填入该值;该AIChat服务器第一次登录Smartbi,必填;以后选填;不填则使用之前已经登录过的CAS认证服务器。

选填

loginMethod

使用的登录方法;枚举值

使用的登录方法,枚举值。普通登录使用login;如果是CAS登录则使用loginWithCas,默认情况下都可以不填。

  • login
  • loginWithCas

普通登录使用login;如果是Cas登录则使用loginWithCas

默认情况下都可以不填

选填

返回值

{
    "code": 0,
    "result": {
        "userId": "",
        "userName": "",
        "userAlias": "",
        "isAdmin":
    },
    "message": "",
    "token": ""
}


4.1.3 接口返回值说明

返回参数名

返回值说明

code

接口调用是否成功;0 - 表示成功;负数为错误码

message

错误描述,code=0 时,该内容为空

token

登录方法特有内容,这个非常重要,后续接口需要传递该值以验证登录

result

调用接口的返回内容,登录接口的返回内容说明如下:

"userId": "",                                                   Smartbi中的用户Id

"userName": "",                                             Smartbi中的用户名

"userAlias": "",                                               Smartbi中的用户中文名

"isAdmin":                                                     在Smartbi中是否是管理员

...