From bf818c108c4a5763102d8aa8071b151e2f0c73b3 Mon Sep 17 00:00:00 2001 From: Michael Dlesk Date: Thu, 29 Dec 2011 18:54:00 -0500 Subject: [PATCH] Updated API Documentation --- API.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/API.md b/API.md index 6cb1ec9..85235dc 100644 --- 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) -
\ No newline at end of file +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. + +
+*Parameters* + +API_KEY - The Gamez API Key (Can be retrieved from Settings page) + + \ No newline at end of file