API - Revision history

WFilter: /* Links */

2019-07-12T05:55:49Z

‎Links

WFilter at 03:09, 21 August 2018

2018-08-21T03:09:56Z

WFilter: /* Introduction */

2017-07-25T08:06:55Z

‎Introduction

WFilter at 08:06, 25 July 2017

2017-07-25T08:06:23Z

WFilter at 09:46, 19 July 2017

2017-07-19T09:46:00Z

WFilter at 09:40, 19 July 2017

2017-07-19T09:40:05Z

WFilter at 09:37, 19 July 2017

2017-07-19T09:37:54Z

WFilter: Created page with "{{DISPLAYTITLE:Open API of WFilter NGF}} = Introduction = WFilter NGF has a built-in API library for developers to manipulate the entire system or integrate WFilter features..."

2017-07-19T09:24:11Z

Created page with "{{DISPLAYTITLE:Open API of WFilter NGF}} = Introduction = WFilter NGF has a built-in API library for developers to manipulate the entire system or integrate WFilter features..."

New page

{{DISPLAYTITLE:Open API of WFilter NGF}}

= Introduction =

WFilter NGF has a built-in API library for developers to manipulate the entire system or integrate WFilter features. With APIs, you’re able to:

1. Monitor system/network status.
2. Monitor bandwidth and online users.
3. Set client access policy.

Available APIs are listed in below:

= Network Status =
== List network interfaces ==
* Function: get_network_interfaces
* Parameter: none
* Return: JSON
* Result format

== Get interface status and statictics ==
* Function: get_network_status
* Parameter: none
* Return: JSON
* Result format

= Bandwidth and user status =
== Get bandwidth history of past N seconds ==
* Function: list_bandwidth
* Parameter: seconds
* Return: JSON
* Result format

== List online users ==
* Function: list_online_users
* Parameters: return rows(max 1000), search string
* Return: JSON
* Result format

== List online connections of a client ==
* Function: list_online_connections
* Parameter: IP address
* Return: JSON
* Result format

= Get Basic Settings =
== List groups ==
* Function: list_group
* Parameter: none
* Return: JSON
* Result format

== List WFilter accounts ==
* Function: list_account
* Parameter: none
* Return: JSON
* Result format

= Set client access policy =
== Terminate connections(kick off user) ==
* Function: kill_connection
* Parameters:
** port : connection local port, 0 for all ports
** type: "ALL"-- all protocols, "RESET"-- reset to default, "REMOVE"-- bypass all blocking, others -- protocol name.
** minutes: blocking minutes
** message: message to be displayed(urlencoded)
* Return: TRUE or FALSE
== Add IP into a virtual group ==
* Function: add_virtual_group
* Parameters:
** groupid: group ID
** ip: client IP
** minutes: stay in this group for N minutes
* Return: TRUE or FALSE
== Remove IP from a virtual group ==
* Function: rm_virtual_group
* Paramter: IP
* Return: TRUE or FALSE

= SDK Download =
== php ==
Download URL: [[Media:WFilterNGF_SDK_php.zip|SDK for php]]

= Links =
* [http://blog.wfilterros.com/?p=520 API overview of WFilter NGF]

@@ Line 125: / Line 125: @@
 = Links =
-* [http://blog.wfilterros.com/?p=520 API overview of WFilter NGF]
+* [http://blog.wfilterngf.com/?p=520 API overview of WFilter NGF]
-* [http://blog.wfilterros.com/?p=313 Integrate paypal payment with your ISP service.]
+* [http://blog.wfilterngf.com/?p=313 Integrate paypal payment with your ISP service.]

@@ Line 88: / Line 88: @@
 * Function: rm_user
 * Paramter: ip or username(urlencoded)
 = SDK Download =

← Older revision		Revision as of 09:46, 19 July 2017
Line 83:		Line 83:
	= Links =		= Links =
	* [http://blog.wfilterros.com/?p=520 API overview of WFilter NGF]		* [http://blog.wfilterros.com/?p=520 API overview of WFilter NGF]
		+	* [http://blog.wfilterros.com/?p=313 Integrate paypal payment with your ISP service.]

@@ Line 5: / Line 5: @@
 WFilter NGF has a built-in API library for developers to manipulate the entire system or integrate WFilter features. With APIs, you’re able to:
-. Monitor system/network status.
+* 1. Monitor system/network status.
-. Monitor bandwidth and online users.
+* 2. Monitor bandwidth and online users.
-. Set client access policy.
+* 3. Set client access policy.
 Available APIs are listed in below:

@@ Line 75: / Line 75: @@
 * Function: rm_virtual_group
 * Paramter: IP
 * Return: TRUE or FALSE
 = SDK Download =

@@ Line 79: / Line 79: @@
 = SDK Download =
 == php ==
-Download URL: [[Media:WFilterNGF_SDK_php.zip|SDK for php]]
+Download URL: [[Media:WFilterNGF_SDK_php.zip|WFilter SDK for php]]
 = Links =
 * [http://blog.wfilterros.com/?p=520 API overview of WFilter NGF]

@@ Line 18: / Line 18: @@
 * Result format
-==  Get interface status and statictics ==
+==  Get interface status and statistics ==
 * Function: get_network_status
 * Parameter: none