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