Image Rendering HTTP protocol basic syntax

This section describes the basic syntax of the Scene7 Image Rendering HTTP protocol.

Item

Definition

request

http:// server/ir/render[/ vignette ] [ ? modifiers ]

server

server_address [ : port ]

vignette

Vignette specifier (relative file path or vignette catalog entry).

modifiers

modifier *[ & modifier ]

modifier

command | { $ macro $ } | { . comment }

command

{ cmdName | { $ var } } [ = value ]

macro

Name of a command macro.

comment

Comment string (ignored by server).

cmdName

Name of a command or attribute.

var

Name of a custom variable.

value

Command or variable value.

server, cmdName, macro, and var are case-insensitive. The server preserves the case of all other string values.

Server identifier

The ’ /ir/render’ root context is required for all HTTP requests to Image Rendering.

Comments

Comments may be embedded into request strings anywhere and are identified by a period (.) immediately following the command separator (&). The comment is terminated by the next occurrence of an (un-encoded) command separator. This feature may be used to add information to the request which is not for Image Serving use, such as time stamps, database ids, etc.

HTTP decoding

Image Rendering first extracts object and modifiers from the incoming request. object is then separated into path elements which are individually HTTP-decoded. The modifiers string is separated into command= value pairs, and value is then HTTP-decoded before command-specific processing.

On this page