The Content API (CAPI) is a service for our clients which enabling them to obtain resized images of specific SKUs. This can be used to create a synchronization service between the clients ecommerce platform and other digital platform and the Cylindo imagery.
Examples of usage for CAPI falls into two categories:
- High request scenarios e.g. where the images are embedded directly on a product listing page or used as thumb imagery on a cart page. This scenario is possible if the maximum resolution requested is equal to or smaller than the resolution of the agreed upon 360 viewport.
- Low requests scenarios e.g. where a local buffer is generated or where marketing material requires high resolution imagery. It is possible to obtain a product image in any resolution smaller than 4096 pixel using CAPI.
In version 3 of the Content API, access requests can be made in the following two ways.
Any requests for images that are smaller or equal to the size of your agreed upon 360 viewport can be made without any authentication. This means that once you have the URL of your images you can use the URL to retrieve images dynamically at runtime. These images are fronted by a CDN for faster access.
Any requests for images that are larger than your agreed upon viewport will require you to programmatically access the Content API and attach your access key in the image retrieval request as described below. You can obtain an access key by contacting firstname.lastname@example.org with a request for access.