diff --git a/templates/api.phtml b/templates/api.phtml index c94b09b..e0ae256 100644 --- a/templates/api.phtml +++ b/templates/api.phtml @@ -35,6 +35,13 @@ if ($this->module['api_key'])
{endpoint}?key={key} where {endpoint} is the call being made and {key} is your API key.
+The API only returns a JSON formatted string and utilizes both HTTP status codes as well as a response_code variable in the results. On error, there will also be a error variable that will contain additional information about the error that was encountered.
+ +To help with readability of the returned JSON we offer the pretty parameter which will force the JSON output to be prettified. Simply add &pretty=true after your key to use this parameter.