---
layout: manual_3.0
title: Endpoints
---
Endpoints
IIIF Image API 1.x
Documentation
Location
This endpoint is available at /iiif/1.
Compliance
Cantaloupe implements version 1.1 of this API, for compatibility with all 1.x clients. Compliance level is dynamically computed and declared on a per-processor basis. Most processors are "Level 2"-compliant.
Information Response Notes
tile_width
and tile_height
- These keys contain refer to tile dimensions that will be relatively efficient to deliver.
- For images that are natively tiled, these will be the smallest of the native tile dimensions, the value of the
endpoint.iiif.min_tile_size
configuration key, or the full image dimensions.
- For untiled images, these will be the smallest value of n for the formula: (smallest dimension) * 1/2n >
endpoint.iiif.min_tile_size
.
formats
- This list of output formats depends on the processor assigned to the format of the source image.
qualities
- Depends on the qualities supported by the processor assigned to the format of the source image.
profile
- Dynamically computed based on the features supported by the processor assigned to the format of the source image, as well as features built into the image server itself.
Enabling/Disabling
This endpoint can be enabled or disabled by setting endpoint.iiif.1.enabled
to true
or false
in the configuration file.
IIIF Image API 2.x
Documentation
Location
This endpoint is available at /iiif/2.
Compliance
Cantaloupe implements version 2.0 of this API, for compatibility with all 2.0 clients. Compliance level is dynamically computed and declared on a per-processor basis. Most processors are "Level 2"-compliant.
Information Response Notes
sizes
- Contains an array of width/height pairs according to the formula dimension * 1/2n > 64. (It is possible to restrict access to only these sizes using the
endpoint.iiif.2.restrict_to_sizes
configuration option.)
tiles
- Contains a list of tile sizes that will be relatively efficient to deliver, along with a list of scale factors at which each size is available.
- For images that are natively tiled, the
width
and height
will be the smallest of the native tile dimensions, the value of the endpoint.iiif.min_tile_size
configuration key, or the full image dimensions.
- For untiled images, they will be the smallest value of n for the formula: (smallest dimension) * 1/2n >
endpoint.iiif.min_tile_size
.
profile/formats
- This list of output formats depends on the processor assigned to the format of the source image.
profile/qualities
- Depends on the qualities supported by the processor assigned to the format of the source image.
profile/supports
- Dynamically computed based on the features supported by the processor assigned to the format of the source image, as well as features built into the image server itself.
service
- See the Service Profile section.
Service Profile
Cantaloupe supports an optional service profile in information responses. The delegate script merely needs to implement the get_iiif2_service()
method. An example implementation of the Physical Dimensions service follows:
{% highlight ruby %}
module Cantaloupe
##
# @param identifier [String] Image identifier
# @return [Hash] that will be transformed to JSON and appended to a
# `service` key in information responses
#
def self.get_iiif2_service(identifier)
# Obviously, some of this info would be retrieved dynamically from a
# database or what have you. This is just an example.
{
'@context' => 'http://iiif.io/api/image/2/context.json',
'profile' => 'http://iiif.io/api/annex/services/physdim/1/context.json',
'physicalScale' => 0.85,
'physicalUnits' => 'cm'
}
end
end
{% endhighlight %}
Enabling/Disabling
This endpoint can be enabled or disabled by setting endpoint.iiif.2.enabled
to true
or false
in the configuration file.