WebAPI

<< Click to Display Table of Contents >>

当前位置:  系统集成 

WebAPI

Previous pageReturn to chapter overviewNext page

WebAPI 是基于servlet实现,API所有的方法的调用需要构建xml格式的请求内容,post到这个servlet,并且返回xml格式的字符串作为响应。想要基于API做集成开发需要构建和解析xml格式字符串,并通过http协议进行通讯。

接口环境配置

1.  在永洪产品的安装目录中找到:Yonghong/tomcat/webapps /bi/WEB-INF/web.xml中添加以下代码:

   <servlet>

   <servlet-name>YonghongWebApi</servlet-name>

   <servlet-class>g5.sv.httpapi.YonghongWebApi</servlet-class>

   </servlet>

   <servlet-mapping>

   <servlet-name>YonghongWebApi</servlet-name>

   <url-pattern>/api</url-pattern>

   </servlet-mapping>

2.  启动产品,将权限设置为文件权限管理系统。即:点击首页,进入管理系统-系统设置-权限管理系统配置,选择文件权限管理系统并点击应用按钮,如下图所示:

api接口2

3.  在浏览器url中输入链接:http://ip:port/bi/api?action=login&adminv=admin&passv=g5,得到登录的token值,如下图所示:

api接口1

4.  下载浏览器插件Postman并安装,安装成功后,Postman界面如下图所示:

api接口3

5.  选择post,输入url:http://ip:port/bi/api?action=xxxx&token=xxxx;输入参数:xmlData以及xmlData的值,点击send,即会在界面上有反馈的结果,如下图所示:

api接口4

 

接口注意事项

1. 每个接口会在请求参数栏标明请求参数是否必填。若请求参数为无,则不需要填写请求参数;若请求参数为必填,则需要填写请求参数;

2.  每个接口的参数描述栏会详细标明请求参数中的参数是否为必填项。若为必填项,请填写对应的内容;若为选填项,则可填可不填,但是仍然需要写出对应标签。例如:添加用户中参数“alias”为选填项,当我们创建的用户没有昵称时,我们仍然需要写上alias的标签,即:<alias></alias>,如下所示:

<?xml version="1.0" encoding="UTF-8"?>

<info>

 <user>

         <name>user1</name>

         <pass></pass>

         <email>test@qq.com</email>

                     <alias></alias>

         <parent></parent>

         <roles></roles>

 </user>

</info>