How To Enable
This feature may be enabled on a per site basis. From the back end administration area, go to Site Config > Edit Site. Then, select the Modules tab. From there, locate the JSON API, and select either Off or On. Then click Update.
The base URL for the API endpoints is:
API Endpoint Reference
On success, the HTTP status code in the response header is
200 OK and the response body contains a data object in JSON format. On error, the header status code is an error code and the response body contains an error object.
Response Status Codes
The JSON API uses the following response status codes:
|200||OK - The request has succeeded. The client can read the result of the request in the body and the headers of the response.|
|400||Bad Request - The request could not be understood by the server due to malformed syntax. The message body will contain more information; see Error Handling, below.|
|401||Unauthorized - The request requires user authentication or, if the request included authoriation credentials, authorization has been refused for those credentials. Also, the JSON API feature may not be enabled for the site; see How To Enable, above.|
|403||Forbidden - The server understood the request, but is refusing ot fulfill it.|
|404||Not Found - The requested resource could not be found. This error can be due to a temporary or permanent condition.|
When an error occurs, the response
data attribute will not exist. The response will instead contan an
Example Error Response
Example Response Handler
Feature added in version 6.2.