User Tools

Site Tools


covers:integration-guide

This is an old revision of the document!


Cover Art Integration Guide

This guide describes how to integrate ChiliFresh Cover Art into your OPAC, discovery layer or library web site.

There are two ways to integrate:

  1. Direct image retrieval — your catalog embeds a ChiliFresh image URL (or your server pulls the image) and the cover is returned as an image. This is the simplest and most common method.
  2. Covers (RESTful) API — your application first queries the API to learn whether a cover exists (and at which sizes) and then retrieves the image URLs from the API response. See Covers (RESTful) API for full reference.

Direct image retrieval

Request

Basic request format:

https://content.chilifresh.com/?isbn=XXXXXXXXXX&size=Y

Live example:

https://content.chilifresh.com/?isbn=9780578033440&size=M

Parameters

Parameter Type (size) Mandatory Description
isbn Variable characters Yes (at least one identifier from these 5) Item's ISBN (ISBN-10 or ISBN-13)
upc Variable characters Item's UPC
oclc Variable characters Item's OCLC number, with the (OCoLC) prefix (not case sensitive), as it appears in the bibliographic record
lccn Variable characters Item's LCCN
issn Variable characters Item's ISSN
size Variable characters (1) No Options: S - small, M - medium, L - large. If empty or incorrect, treated as S
generic Boolean No Default true: if no actual cover exists, a generic placeholder image (book title/author) is returned. Set generic=false to disable generic images
showerror Boolean No Default false: if no image is returned, the output is a blank 1×1 px GIF. Set showerror=true to return an HTTP 404 error instead

At least one identifier parameter (isbn, upc, oclc, lccn or issn) must be present. Any identifier parameter accepts multiple values as a comma-separated list, and several identifier parameters can be combined in one request — see below.

Supported identifiers

The following item identifiers are accepted as request parameters:

Parameter Identifier Notes
isbn ISBN ISBN-10 or ISBN-13
upc UPC
oclc OCLC number Currently expected with the (OCoLC) prefix (not case sensitive), exactly as the number appears in the bibliographic record — including any ocm/ocn/on prefixes if present. See examples below
lccn LCCN
issn ISSN

Each identifier parameter accepts either a single value or multiple values as a comma-separated list.

Provide multiple identifiers at once — pass all identifiers you have on the bibliographic record in a single request:

https://content.chilifresh.com/?isbn=9780578033440&oclc=(OCoLC)4048055&size=M

Identifiers are processed in the order provided and the first existing cover image is returned. Supplying every identifier you have (ISBN, UPC, OCLC, …) maximizes the chance of retrieving a cover.

The same applies to multiple values of the same identifier type: pass them as a comma-separated list — they are processed in order and the first match is returned. Example with several ISBNs from one record:

https://content.chilifresh.com/?isbn=9780578033440,0807282588&size=M

OCLC number examples (as they appear in bibliographic records):

https://content.chilifresh.com/?oclc=(OCoLC)ocm50035236&size=M
https://content.chilifresh.com/?oclc=(OCoLC)ocn933282680&size=M
https://content.chilifresh.com/?oclc=(OCoLC)on1021885771&size=M
https://content.chilifresh.com/?oclc=(OCoLC)pcl00007081&size=M
https://content.chilifresh.com/?oclc=(OCoLC)4048055&size=M

Image sizes

Three image sizes are available via the size parameter:

Size Value Max dimensions Example (isbn=0807282588)
Small S 70 x 100 px Small cover example
Medium M 150 x 240 px Medium cover example
Large L 300 x 480 px Large cover example

If the size parameter is omitted (or invalid), the small image is returned.

When no cover image exists

  • Generic placeholder image (default). By default, generic images are enabled: if no actual cover exists, a placeholder image showing the book title and author is returned. A returned generic image is a normal image response — it is not treated as a miss.
  • Disabling generic images. To disable generic images, add generic=false to the retrieval URL:
    https://content.chilifresh.com/?isbn=9780578033440&size=M&generic=false
  • Blank 1×1 px GIF. If no image is returned (no actual cover and no generic image), the output is a blank 1×1 px GIF image.
  • 404 error instead of blank GIF. If you prefer an HTTP 404 response instead of the blank GIF (useful for server-side integrations that check the response code), add showerror=true to the retrieval URL:
    https://content.chilifresh.com/?isbn=9780578033440&size=M&generic=false&showerror=true

Custom placeholder: you can also provide your own placeholder image to be displayed instead of the ChiliFresh generic image — contact support@chilifresh.com to set this up.

Examples

Description Request URL
Small cover (default size) https://content.chilifresh.com/?isbn=0807282588
Medium cover https://content.chilifresh.com/?isbn=0807282588&size=M
Large cover https://content.chilifresh.com/?isbn=0807282588&size=L
Multiple ISBNs (first match returned) https://content.chilifresh.com/?isbn=9780578033440,0807282588&size=M
Multiple identifier types https://content.chilifresh.com/?isbn=9780578033440&oclc=(OCoLC)4048055&size=M
OCLC number https://content.chilifresh.com/?oclc=(OCoLC)ocm50035236&size=M
No generic image, 404 on miss https://content.chilifresh.com/?isbn=9780578033440&generic=false&showerror=true

Covers (RESTful) API

If your application needs to know whether a cover exists before rendering (e.g. to control layout, caching or fallbacks), use the Covers API. It returns availability flags and cover URLs for each size, with XML and JSON output.

Full reference: Covers (RESTful) API

Host authorization (whitelisting)

Authorization for image display is managed through white-listing in the ChiliFresh Admin panel → Covered hosts. Enter there:

  • Client-side retrieval (the patron's browser loads images directly from ChiliFresh): the hostnames of your catalog and web pages that will display the images.
  • Server-side retrieval (your server pulls images from ChiliFresh): the IP address(es) of the server(s) that will be pulling the images.

Please note:

  • Images are returned even if your host/IP is not yet entered — however, hosts that are not white-listed are eventually blocked. Enter your hosts/IPs before going live.
  • The white-listed hosts/IPs are also used for collecting the usage statistics displayed on the Admin panel.

Client-side vs server-side integrations

Integration type How it works Whitelist entry Examples
Client-side The catalog page includes the ChiliFresh image URL directly in its HTML; the patron's browser retrieves the image Catalog / web page hostnames Innovative Polaris (live example), Innovative Encore, SirsiDynix Enterprise
Server-side The catalog server retrieves (and typically caches) the image from ChiliFresh and serves it to patrons itself Server IP address(es) Evergreen, Aspen Discovery

Support

Questions about integration, custom placeholder images or white-listing: support@chilifresh.com.

covers/integration-guide.1784270104.txt.gz · Last modified: 2026/07/17 02:35 by jposeika