Realtime Processing - Overview
Realtime Image Processing API Services Base Endpoint
All realtime image processing API service endpoints listed in this documentation are relative to https://edge.sandcage.com/<YOUR REAL-TIME PROCESSING ENDPOINT KEY>/0.2/.
Although requests can be sent over cleartext HTTP, we recommend using the HTTPS protocol so that traffic is encrypted. Any tool that is fluent in HTTP can communicate with the API.
The SandCage realtime image processing API is a mostly RESTful API. Overview:
- All realtime image processing API services should be called over HTTP GET.
- You can consider any non-200 and non-3** HTTP response code an error.
- The endpoint of each of the API services can be accessed at: https://edge.sandcage.com/<YOUR REAL-TIME PROCESSING ENDPOINT KEY>/0.2/<SERVICE-ENDPOINT>?<parameters>
- All requests will be cached by and delivered by the nearest CDN edge, resulting in a much faster delivery.
- All requests will temporarily cache the source image, resulting in a much faster processing and delivery time on consecutive processing requests on the same source image.
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 via url encoded GET parameters to the respective API service endpoints. The documentation for each API service will contain more details on the structure and conditions of the parameters of the respective service.
For information regarding the detailed responses of each of the services check the corresponding service documentation.
Source images can be provided either with a relative or absolute URL path.
To mask the absolute path of a given source file an origin mapping can be assigned to the Realtime API Key.