Show Menu
TOPICS×

Introduction

This document describes the HTTP protocol for Scene7 Image Rendering.
Only the publicly available aspects of the protocol are described. The server may support additional commands which are reserved for use by Scene7 client software.
Intended audience
This documented is intended for experienced programmers and website developers who want to leverage Scene7 Image Rendering for a website or a custom application.
It is assumed that the reader is familiar with Scene7 Image Authoring and Image Rendering, general HTTP protocol standards and conventions, and basic imaging terminology.
Document conventions
literal
In syntax sections, non-italic text is literal; this does not apply to white space and the symbols [ ] { } | *.
'literal'
In descriptive sections, non-italic text in single quotes is literal.
parameter
Italics indicate a variable or parameter, to be substituted with an actual value.
attribute::Item
A name prefixed with 'attribute::' refers to an image catalog attribute.
catalog::Item
A name prefixed with 'catalog::' refers to a material catalog data field.
icc::Item
A name prefixed with 'icc::' refers to a field in the ICC color profile map.
macro::Item
A name prefixed with 'macro::' refers to a field in the macro definition table.
ruleset::Item
A name prefixed with 'ruleset::' refers to an element in a URL pre-processing rule set.
default::Item
A name prefixed with 'default::' refers to an attribute of the default image catalog.
vignette::Item
A name prefixed with 'vignette::' refers to a field in the vignette map.
[ optional ]
Optional syntax elements are enclosed by square brackets.
*[ optional ]
The optional syntax element may be repeated none or more times.
item1 | item2
A vertical bar indicates that either the single syntax item to the left or the item to right may be used. Exactly one item must be selected.
{ group }
Curly braces are used to group syntax elements.
*{ group }
The syntax elements within the group may be repeated one or more times.
white space
White space (spaces or tabs) is not allowed in HTTP requests. This document occasionally uses white space between syntactic elements for clarity only.
Common terms
** MSS ** Material Specification Segment: a set of material attributes between two selection commands in the request.
** vignette ** An image prepared in Scene7 Image Authoring for use with Image Rendering.