*******************
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:


Staging
=======

===========================================  ========================
Fastly url                                   corresponding vulcan url
-------------------------------------------  ------------------------
http://stag-media.gq.com/                    http://stg-vulcan-api.aws.conde.io/gq/
http://stag-assets.teenvogue.com/            http://stg-vulcan-api.aws.conde.io/teenvogue-services/
http://stag-assets.epicurious.com/           http://stg-vulcan-api.aws.conde.io/epi/
http://stag-media.golfdigest.com/            http://stg-vulcan-api.aws.conde.io/gd-services/
http://stag-assets.vogue.com/                http://stg-vulcan-api.aws.conde.io/vogue-services/
http://stag-media.vanityfair.com/            http://stg-vulcan-api.aws.conde.io/vf/
http://stag-media.architecturaldigest.com/   http://stg-vulcan-api.aws.conde.io/ad-services/
http://stag-media.details.com/               http://stg-vulcan-api.aws.conde.io/details-services/
http://stag-assets.bonappetit.com/           http://stg-vulcan-api.aws.conde.io/bonappetit-services/
http://stag-media.allure.com/                http://stg-vulcan-api.aws.conde.io/all-services/
http://stag-media.glamour.com/               http://stg-vulcan-api.aws.conde.io/glm-services/
http://stag-media.cntraveler.com/            http://stg-vulcan-api.aws.conde.io/cnt-services/
http://stag-media.wmagazine.com/             http://stg-vulcan-api.aws.conde.io/wmag-services/
http://stag-media.brides.com/                http://stg-vulcan-api.aws.conde.io/brides-services/
http://stag-media.cntrending.com/            http://stg-vulcan-api.aws.conde.io/snd-services/
http://stag-media.wired.com/                 http://stg-vulcan-api.aws.conde.io/wp/wired-wp/
===========================================  ========================


Production
==========

======================================  ========================
Fastly url                              corresponding Vulcan url
--------------------------------------  ------------------------
http://media.gq.com/                    http://vulcan-api.aws.conde.io/gq/
http://assets.teenvogue.com/            http://vulcan-api.aws.conde.io/teenvogue-services/
http://assets.epicurious.com/           http://vulcan-api.aws.conde.io/epi/
http://media.golfdigest.com/            http://vulcan-api.aws.conde.io/gd-services/
http://assets.vogue.com/                http://vulcan-api.aws.conde.io/vogue-services/
http://media.vanityfair.com/            http://vulcan-api.aws.conde.io/vf/
http://media.architecturaldigest.com/   http://vulcan-api.aws.conde.io/ad-services/
http://media.details.com/               http://vulcan-api.aws.conde.io/details-services/
http://assets.bonappetit.com/           http://vulcan-api.aws.conde.io/bonappetit-services/
http://media.allure.com/                http://vulcan-api.aws.conde.io/all-services/
http://media.glamour.com/               http://vulcan-api.aws.conde.io/glm-services/
http://media.cntraveler.com/            http://vulcan-api.aws.conde.io/cnt-services/
http://media.wmagazine.com/             http://vulcan-api.aws.conde.io/wmag-services/
http://media.condenast.io/              http://vulcan-api.aws.conde.io/engineering-services/
http://media.cntrending.com/            http://vulcan-api.aws.conde.io/snd-services/
http://assets.wired.com/                http://vulcan-api.aws.conde.io/wp/wired-wp/
======================================  ========================


.. _wordpress-url-schema:

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
  :doc:`transformations </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 :ref:`supported-url-parameters` for supported URL parameters.