API Services Base Endpoint
All API service endpoints listed in this documentation are relative to http://api.sandcage.com/0.2/. Requests should be made using the HTTPS protocol so that traffic is encrypted.
For example, the full URL endpoint of the "Schedule Tasks" service is reachable at http://api.sandcage.com/0.2/schedule-tasks.
Any tool that is fluent in HTTP can communicate with the API.
The SandCage API is a mostly RESTful API. Overview:
- All API services should be called over HTTP POST.
- You can consider any non-200 HTTP response code an error.
- The endpoint of each of the API services can be accessed at: http://api.sandcage.com/0.2/SERVICE-ENDPOINT
Response HTTP Statuses
All requests will return standard HTTP statuses, including error codes. Requests resulting in a 200 HTTP response code will contain more detailed information.
In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered.
Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed.
If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having an issue on our end and cannot fulfill your request currently.
Request data should be provided to the API by POSTing JSON objects to the respective API service endpoints with the appropriate parameters. The documentation for each API service will contain more details on the structure and conditions of the parameters of the respective service.
All responses are JSON formated. For the detailed response data of each of the services check the corresponding service documentation.