API - Revision history

Russell: /* Network Related */ Fix Server and TrustedFP links

2020-04-22T19:40:02Z

Network Related: Fix Server and TrustedFP links

Russell: /* User Related */ Update whitelist and network links

2020-04-22T19:06:44Z

User Related: Update whitelist and network links

Russell: /* General */ Friendly Link Titles

2020-04-22T16:52:36Z

General: Friendly Link Titles

Russell: /* Network Related */ Friendly Link Titles

2020-04-22T16:52:14Z

Network Related: Friendly Link Titles

Russell: /* User Related */ Friendly Link Titles

2020-04-22T16:51:38Z

User Related: Friendly Link Titles

Russell: Very basic API information provided (TODO: More Details)

2020-04-22T15:59:19Z

Very basic API information provided (TODO: More Details)

New page

= API =
This module provides an API that returns data from the bouncer in [https://en.wikipedia.org/wiki/JSON JSON] format

== Functions ==

The API comes with a number of functions that can be used to both retrieve and update information, these are as follows:

=== General ===
* [[API:Status]]

=== User Related ===
* [[API:User/Info]]
* [[API:User/Update]]
* [[API:User/Network]]
* [[API:User/Whitelist]]

=== Network Related ===
* [[API:Network/Info]]
* [[API:Network/Update]]
* [[API:Network/Server]]
* [[API:Network/TrustedFP]]

== Usage ==

=== Obtaining an API Key ===

To obtain a key, you will need to login your bouncer using IRC. Once logged in, you need to issue the following command:
/msg *api generate
This will generate an API key for you to use. '''Please note''' that you will need to save your API key as once generated, it will not be displayed to you again. Should you lose your API key, you will need to use generate again to generate a new one.

=== Sending a Request ===

All requests to the API must be sent using HTTP POST to [https://api.bnc4free.com/ https://api.bnc4free.com/] along with a minimum of the below required variables:

{| class="wikitable"
! style="font-weight:bold;" | Variable
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Example Value
|-
| server
| This is the name of the server you wish to query (normally the server your account is on
| Apple
|-
| username
| This is the username you use normally to login to the bouncer
| TestyTest
|-
| key
| The generated API key
| d681883383bcf7963427b1629d0b9963cf6335b5
|}

The function name from [[:Category:API_Functions|API Functions]] should also be appended to the URI (E.g [https://api.bnc4free.com/status https://api.bnc4free.com/status])

=== Example Response ===

If your API query has been successful, you should receive a successful response which will look like the below:
{
"status":"online",
"uptime":"2h 38m 32s",
"version":"fBNC - https://bnc4free.com"
}
''Source: [https://api.bnc4free.com/status https://api.bnc4free.com/status]''

@@ Line 21: / Line 21: @@
 * [[API:Network/Info|Network/Info]]
 * [[API:Network/Update|Network/Update]]
-* [[API:Network/Server|Network/Server]]
+* [[API:Network/Server/Add|Network/Server/Add]]
-* [[API:Network/TrustedFP|Network/TrustedFP]]
+* [[API:Network/Server/Delete|Network/Server/Delete]]
 == Usage ==

@@ Line 12: / Line 12: @@
 * [[API:User/Info|User/Info]]
 * [[API:User/Update|User/Update]]
-* [[API:User/Network|User/Network]]
+* [[API:User/Network/Add|User/Network/Add]]
-* [[API:User/Whitelist|User/Whitelist]]
+* [[API:User/Network/Delete|User/Network/Delete]]
 === Network Related ===

@@ Line 7: / Line 7: @@
 === General ===
-* [[API:Status]]
+* [[API:Status|Status]]
 === User Related ===