Image API

Request Format

http://iiif.nli.org.il/IIIFv21/{identifier}/{region}/{size}/{rotation}/{quality}.{format}

The Image API is a web service that returns an image in response to a standard HTTP request. The URI can specify the region, size, rotation, quality characteristics and format of the requested image.

The region specification of an image formats a portion of a digital image to be returned to the browser.

The Image API can be adopted by any image repository or service, and can be used to retrieve static images in response to a properly constructed URI.

Input

Parameter Description
identifier The identifier of the digital page you want to access, In the manifest API, it is represented by images-> @id
region The area of the image you want to get
  • Full – to get the whole image at the output
  • x,y,w,h - Starting point according to pixels (x, y), and from it a selected area in pixels (w, h)
size The dimensions of the image you want to get (width, height)
rotation Rotate the image (degrees) clockwise (0,90,180,270);
Rotate and mirror the image (degrees) clockwise (0!, 90!, !180,!270)
Quality The image is returned in full color (default) or grayscale color (grey)
format Image file format. Currently, only JPEG format is supported

Secondary Usage

http://iiif.nli.org.il/IIIFv21/DOCID/{DOCID}/manifest

Parameter Description
Identifier The Identifier (Primo DOCID) of the record. (Exists, if an item is indexed by Primo system) In Search API output, it is defined as Identifier.