Image Manager API

Image Manager transforms a website’s images by creating derivative images of various sizes and formats, and dynamically selecting the best image when requested by an end user.

The Image Manager API is an end-to-end solution to archive, manage, and deliver transformed images based on customer defined policies.

About this Document

This document is arranged as follows:

  • This Overview helps you get set up with the API’s initial requirements, introduces you to the many concepts you will need to know, and details various API conventions.

  • The Uses section provides an end-to-end guide of Image Manager’s main capabilities, demonstrating how to interact with each API interface.

  • The Debug section describes the mechanism that reports errors, but does not catalog the range of errors the API releases.

  • The Resources section specifies the API’s resource model, detailing each API operation.

The Overview discusses the following topics:

  • Getting Started provides information on what you need to do before using this API.

  • Image Manager API Concepts provides an overview of the API’s conceptual elements, and how they relate to API interfaces.

Who Should Use this API

The Image Manager API allows developers and architects to automate their entire imaging workflow to create, store, manage and deliver a rich image experience to every user, on any device, anywhere. To use this API, you should be familiar with HTTP requests and responses, and should read all sections and complete all tasks included in this Overview.

Getting Started

To get started with this API:

Image Manager API Concepts

This section provides a road map of all the conceptual objects you deal with when interacting with this API, and provides pointers to where you can learn more.

  • Automatic Transformations: Image Manager automatically transformation a website’s images by creating derivative images of various sizes and formats, and dynamically selecting the appropriate image when requested by an end user. Policies can be created to modify how a website’s images are transformed (see Policies).

  • On-Demand Transformations: Image Manager also supports on-demand transformations, using query string parameters that allow web developers to: specify which of the derivative images should be selected; force a particular output format to be selected or specify a different policy. For detailed information on query string parameters and examples, see the Uses section.

  • Policies: Policies are used to create variations (size and formats) to deliver the best image for the application. For detailed information on Image Manager policies and examples, see the Uses section.