Updated API Documentation

Martijn085 · Dec 29, 2011 · bf818c1 · bf818c1
1 parent f3c77dd
commit bf818c1
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/API.md b/API.md
@@ -7,4 +7,17 @@ The below documentation will use http://localhost:8085/ as the base URL for Game
 
 The API function for Gamez is accessed through the '/api' page (http://localhost:8085/api)
 
-<hr />
+JSON responses will be returned.
+
+If the URL is accessed without any parameters, an error will be returned in the format: [{"Error" : "Error Message"}]
+
+The API Key is a required parameter
+
+Currently, no API actions are implemented.
+
+<hr />
+*Parameters*
+
+API_KEY - The Gamez API Key (Can be retrieved from Settings page)
+
+</hr>