在使用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#調用API的示例工程: