RSSBus API调用示例及说明（数据库篇）

在使用RSSBus API之前要具备几个条件：

1.RSSBus授权的Authtoken，相当于一个使用API的key，需要先进行授权才可以使用。

2.RSSBus授权的访问IP，在RSSBus服务器上，需要先配置你的访问IP地址，不然将无法调用RSSBus API。

3.如果你是想通过调用API来操作中间数据库的话，还必须在RSSBus服务器上使用API Port连接数据库，并对相关的表/视图进行授权。

下面以SQLServer数据库为例，主要介绍如何使用API对数据表进行操作：

RSSBus API请求类型：

请求类型共分为四种：GET、POST、DELETE、PUT---四种method分别对应：查询、插入、删除、修改四种操作。

数据类型为json。

用部署在本地的RSSBus环境进行调用说明：

1.首先登陆RSSBus，在API Port中的Users Tab 添加user，会自动生成一个Authtoken：

2.然后在Server Tab中添加信任IP地址：

3.在connection Tab中连接数据库

4.添加数据库资源同时配置权限

上述步骤都完成后，就可以使用http请求调用API了。

比如现在要查询order_header表的数据，就可以发一个GET请求：

对应的URL为：

使用postman调用API：

下面详细叙述一下附加条件和参数的请求。

方法一：假如想查询主键id为5的order表信息，可以直接在后面加 (5)

http://localhost:8201/port/TestAPI/api.rsc/Grant_dbo_order_header(5)

方法二：也可以在URL的最后拼一个filter，例如：

http://localhost:8201/port/TestAPI/api.rsc/Grant_dbo_order_position?$filter=header_id eq 5

查询结果如下图所示：

这种方法可以加多个条件进行过滤，例：

注：此方法只能用于GET请求，其余类型的请求均不适用。

方法三：URL可以写成：http://localhost:8201/port/TestAPI/api.rsc/Grant_dbo_order_header(id=5)

也可以附加多个条件，使用“,”分隔：

http://localhost:8201/port/TestAPI/api.rsc/Grant_dbo_order_position(header_id=5,id=3)

查询结果如下：

可以看出来与方法二效果一样，但是此方法可以用于别的请求类型，DELETE/PUT请求都适用，所以推荐使用方法三进行API调用。

 

最后附一个使用C#调用RSSBus API的示例工程：

下载C#示例