Gridnet Radio System/API - Revision history

Shymus: /* Optional JSON data for API Call: */

2018-10-31T20:49:44Z

‎Optional JSON data for API Call:

Shymus at 19:51, 30 October 2018

2018-10-30T19:51:04Z

Johnny at 19:40, 4 October 2018

2018-10-04T19:40:56Z

Shymus at 14:52, 2 October 2018

2018-10-02T14:52:04Z

Shymus: Added Transmit Message.

2018-10-02T14:51:41Z

Added Transmit Message.

Johnny at 23:31, 27 September 2018

2018-09-27T23:31:24Z

Johnny: Created page with "← Gridnet Radio System {|align=right |TOC |} = '''API Documentation''' = :If you have scripting knowledge, y..."

2018-09-27T22:08:03Z

Created page with "← Gridnet Radio System {|align=right |__TOC__ |} = '''API Documentation''' = :If you have scripting knowledge, y..."

New page

[[Gridnet Radio System|← Gridnet Radio System]]
{|align=right
|__TOC__
|}
= '''API Documentation''' =

:If you have scripting knowledge, you can take advantage of GridNet's API and begin creating your own tools & devices that control your network.

:To navigate this wiki better, please use the navigation on the right side of the screen.

=== API Actions: ===
----
* Get Network Details
* Create Zone
* Delete Zone
* Zone ID to Name
* Zone Name to ID
* Zone List
* Zone Channel List
* Create Channel
* Delete Channel
* Channel Name to ID
* Channel ID to Name

=== How to make an API Call: ===
----
Before you can make a call to the API, you must first create and obtain an API key from your GridNet dashboard.
To do this, log into your GridNet Dashboard, select the network, then navigate to "API" and select "Add API Key" to generate a new API Key.

If you aren't the owner or manager of a network and you'd like to use the API, you'll need to check with network owner about acquiring one.

=== Prerequisites:===
----
You'll need to include the following global functions & variables into your script in order to successfully call an API action:

<pre>
string network_api_key = "YOUR-NETWORK-API-KEY-GOES-HERE";

string GenerateHash(string api_key, string data) {
return llSHA1String(api_key+""+llStringToBase64(data));
}

SendToServer(string json_data) {
string hash = GenerateHash(network_api_key, json_data);
req_id = llHTTPRequest("https://gridnet.nexus-sl.net/api/index.php?",[
HTTP_METHOD,"POST",
HTTP_MIMETYPE,"application/x-www-form-urlencoded"
],"hash="+hash+"&api_key="+network_api_key+"&data="+llStringToBase64(json_data));
}
</pre>

All API Calls are sent to our server in JSON format. Each function listed below contains the list of requirments that you must first set in your JSON string prior to executing the <code>SendToServer(string json_data)</code> function.

= '''Get Network Details:''' =

This function will return the following details pertaining to the specified network:
* Network ID
* Network Owner
* Server Location
* Devices Connected
* Channel Count
* Zone Count
* Transmission Count

=== Required JSON data for API Call: ===
* "action" : "get_network_details"

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"get_network_details");
json = llJsonSetValue(json,["network_id"],network_api_key);
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"network_id" : "12",
"network_owner" : "Johnny Nexen",
"server_location" : "Silesia",
"devices_connected" : "12",
"channel_count" : "2",
"zone_count" : "3",
"transmission_count" : "50"
}
</pre>

= '''Create Zone:''' =

This function allows you to create a new zone that is associated with the supplied API Key.

=== Required JSON data for API Call: ===
* "action" : "create_zone"
* "zone_name" : "The Name of Your New Zone"

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"create_zone");
json = llJsonSetValue(json,["zone_name"],"Fire Dept");
SendToServer(json);
</pre>

=== Example Response: ===
zone_id is returned upon successful zone creation.
<pre>
{
"zone_id" : 20
}
</pre>

= '''Delete Zone:''' =

This function allows you to delete a zone that is associated with the supplied API Key.

=== Required JSON data for API Call: ===
* "action" : "delete_zone"
* "zone_id" : The 'zone_id' number

Unsure how to obtain the "zone_id"? View the API function: [[#Zone Name to ID:]]

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"delete_zone");
json = llJsonSetValue(json,["zone_id"],"12");
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"success" : TRUE
}
</pre>

= '''Zone ID to Name:''' =

This function will fetch the zone name by providing the zone ID.

=== Required JSON data for API Call: ===
* "action" : "zone_id_to_name"
* "zone_id" : The 'zone_id' number

Unsure how to obtain the "zone_id"? View the API function: [[#Zone Name to ID:]]

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"zone_id_to_name");
json = llJsonSetValue(json,["zone_id"],"12");
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"zone_name" : "Fire Dept"
}
</pre>

= '''Zone Name to ID:''' =

This function will fetch the zone ID by providing the zone name.

=== Required JSON data for API Call: ===
* "action" : "zone_name_to_id"
* "zone_name" : The name of the zone

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"zone_name_to_id");
json = llJsonSetValue(json,["zone_name"],"Fire Dept");
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"zone_id" : 20
}
</pre>

= '''Zone List:''' =

This function will return a list of all your created zones.

=== Required JSON data for API Call: ===
* "action" : "zone_list"

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"zone_list");
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"zone_list" : ["Fire Dept","Poice Dept","Medical","DOT"]
}
</pre>

= '''Zone Channel List:''' =

This function will return a list of all the channels within the specified zone.

=== Required JSON data for API Call: ===
* "action" : "zone_channel_list"
* "zone_id" : "20"

Unsure how to obtain the "zone_id"? View the API function: [[#Zone Name to ID:]]

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"zone_channel_list");
json = llJsonSetValue(json,["zone_id"],"20");
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"channel_list" : ["Engine - 22","Ladder-21","Engine - 21","Tanker - 21","Chief"]
}
</pre>

= '''Create Channel:''' =

This function will create a channel within the specified zone.

=== Required JSON data for API Call: ===
* "action" : "create_channel"
* "zone_id" : The 'zone_id' number you'd like to create the channel under

Unsure how to obtain the "zone_id"? View the API function: [[#Zone Name to ID:]]

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"create_channel");
json = llJsonSetValue(json,["zone_id"],"20");
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"channel_id" : 30
}
</pre>

= '''Delete Channel:''' =

This function will delete the channel within the specified zone.

=== Required JSON data for API Call: ===
* "action" : "delete_channel"
* "zone_id" : The 'zone_id' number
* "channel_name" : The name of the channel you'd like to delete

Unsure how to obtain the "zone_id"? View the API function: [[#Zone Name to ID:]]

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"delete_channel");
json = llJsonSetValue(json,["zone_id"],"20");
json = llJsonSetValue(json,["channel_name"],"Fire Dept");
SendToServer(json);
</pre>

= '''Channel Name to ID:''' =

This function will return the channel ID of the provided channel name that is in the specified zone.

=== Required JSON data for API Call: ===
* "action" : "channel_name_to_id"
* "zone_id" : The 'zone_id' number that the channel is linked to
* "channel_name" : The name of the channel that you'd like the ID for

Unsure how to obtain the "zone_id"? View the API function: [[#Zone Name to ID:]]

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"channel_name_to_id");
json = llJsonSetValue(json,["zone_id"],"20");
json = llJsonSetValue(json,["channel_name"],"Fire Dept");
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"channel_id" : 30
}
</pre>

= '''Channel ID to Name:''' =

This function will return the channel name of the provided channel ID.

=== Required JSON data for API Call: ===
* "action" : "channel_id_to_name"
* "channel_id" : The channel ID that you'd like the name for

=== API Call Example: ===
<pre>
json = llJsonSetValue("",["action"],"channel_id_to_name");
json = llJsonSetValue(json,["channel_id"],"30");
SendToServer(json);
</pre>

=== Example Response: ===
<pre>
{
"channel_name" : "Fire Dept"
}
</pre>

@@ Line 343: / Line 343: @@
 * "channel_id": If you are sending a message on a channel, then you need to supply the channel_id.
 * "zone_id": If you are sending a zone message, you need to supply a zone_id.
 === API Call Example: ===

← Older revision		Revision as of 14:52, 2 October 2018
Line 23:		Line 23:
	* Channel Name to ID		* Channel Name to ID
	* Channel ID to Name		* Channel ID to Name
		+	* Transmit Message

@@ Line 379: / Line 379: @@
+{
      string hash = GenerateHash(network_api_key, json_data);
-     req_id = llHTTPRequest("http://gridnet.nexus-sl.net/api/index.php?",[
+     req_id = llHTTPRequest("https://gridnet.nexus-sl.net/api/index.php?",[
          HTTP_METHOD,"POST",
          HTTP_MIMETYPE,"application/x-www-form-urlencoded"

@@ Line 357: / Line 357: @@
 <pre>
+{
-	"channel_name" : "Fire Dept"
+	"success" : TRUE
+}
 </pre>

@@ Line 319: / Line 319: @@
 json = llJsonSetValue("",["action"],"channel_id_to_name");
 json = llJsonSetValue(json,["channel_id"],"30");
 SendToServer(json);
 </pre>
@@ Line 419: / Line 450: @@
+             }
              else llOwnerSay("ERROR >> " + b);
+         }
+     }
+}
 </pre>

@@ Line 39: / Line 39: @@
 <pre>
 string network_api_key = "YOUR-NETWORK-API-KEY-GOES-HERE";
 string GenerateHash(string api_key, string data) {
@@ Line 325: / Line 326: @@
+{
 	"channel_name" : "Fire Dept"
+}
 </pre>