Here is a summary of what is required to use CAPI:
- Knowledge of the SKU you want to retrieve and its parameters (size, frame etc.).
- Your access key - if the size that you are requesting is larger than your default viewer size then include your CAPI access key. You can obtain an access key by contacting email@example.com with a request for CAPI access.
It is best practice to create a switch in your ecommerce platform that can enable the Cylindo 360 HD Viewer on a per product basis. This can be used to quickly switch between the Cylindo 360 HD Viewer experience and a static image you host. If you do not have imagery to use as a static image then Cylindo can provide the images to you which you can use (e.g. the first frame of the viewers). Or you can use the CAPI to download the images programmatically. Examples for how you can retrieve images with CAPI are given in section 6 of this document.
It is however only possible to do so if using a technology that allows for dynamic server side content such as e.g. php, aspx, etc. The size requested from CAPI determines what is needed to request an CAPI image. If you select a size that is larger than your standard 360 image resolution then you need to add an authorization header (request your authorization details from firstname.lastname@example.org). When requesting images larger than your standard 360 image size then you are allowed to request images from the API at a rate of one image per second.
A higher frequency of request means some requests will be throttled (returns a 429 HTTP response). Any images dimension equal to or lower than your standard 360 size can be retrieved without an authorization header. We do however reserve the right to block requests if we deem the service is being misused. For more information regarding CAPI please see our CAPI documentation.