Using Vulcan

CDN URLs

On staging and production environments, Vulcan can be utilized using an seo-friendly, fastly-backed url. Usage is almost identical, except that the brand-identifier is omitted.

The mapping for staging is as follows:

Constructing a Vulcan URL

Copilot API

for Copilot APIs, Vulcan urls generally follow the following format:

http://stg-vulcan-api.aws.conde.io/{brand}/{type}/{id}/{aspectRatio}/{transformations}/{filename}

WordPress

WordPress-based sites use the following format:

http://stg-vulcan-api.aws.conde.io/wp/{brand}/{type}/{transformations}/{path*}

where {path*} is the full path of the image following the “uploads” portion of the WordPress image’s URL. For example, this image:

https://www.wired.com/wp-content/uploads/2016/05/FILENAME_HERE001.jpg

Would have a corresponding Vulcan URL at

http://stg-vulcan-api.aws.conde.io/wp/wired-wp/photos/pass/wp-content/uploads/2016/05/FILENAME_HERE001.jpg

Note that WordPress-based Vulcan URLs don’t contain an {aspectRatio} field. Vulcan will not crop or auto-crop WordPress images.

Parameters

Parameters of a Vulcan URL are:

  • {brand}: The brand identifier as defined in the brand’s API’s config.
  • {type}: The image type - one of: photos, cartoons, or clips
  • {id}: The ID of the image in question. This is in the top-level “id” of the example payload above.
  • {aspectRatio}: The source aspect ratio to transform.
  • {transformations}: Transformations to apply to the image see transformations for more.
  • {filename}: The filename of the image. This is in the top-level “filename” field in the example payload above.

An example would be:

http://stg-vulcan-api.aws.conde.io/demo/photos/55707fd647bbc36c3a6f88d7/1:1/w_100,h_300,c_limit/override.png

See Supported URL parameters for supported URL parameters.