/iiif
Serve the IIIF Image Information (info.json) for a file version, per the IIIF Image API 2.0. Reading the image requires RIGHT_ASSET_SHOW. Tiles and image derivatives are served from the sibling .../{region}/{size}/{rotation}/{quality}.{format} paths.
GET /eas/iiif/{fileId}/{hash}/obj_uuid/{obj_uuid}/{x-fylr-signature}/{version}/info.json
The IIIF endpoint serves images and tiles.
Access token in the Authorization header:
Authorization: Bearer <token>.
The ID of the file.
The hash is the file.hash as described here.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs.
The file.class_extension as described here.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs. The signature will be taken from the query parameter first and if not found, from the request header.
The signature to omit file permission checks. It will be added to the URL when
retrieved through /api/db, /api/search or other endpoints which deliver
fylr URLs. The signature will be taken from the query parameter first and if
not found, from the request header.
Contains the IIIF image information.
IIIF Image API 2.0 image information document — the standard
reply to a /info.json request, defined by the IIIF Image API
2.0 specification.
fylr serves this document so any IIIF-aware client (Mirador, Universal Viewer, OpenSeadragon, ...) can discover the image's dimensions, supported tile sizes and feature profile.
JSON-LD context — always the IIIF Image API 2 URL.
The image's IIIF service URL — /info.json without the
/info.json suffix.
The IIIF protocol URI.
The image's native width, in pixels.
The image's native height, in pixels.
Access to the file is denied (code InsufficientRights):
the caller holds neither asset_show nor asset_download on the
file (holding either one is enough; anonymous requests are checked
against the deep_link user), or the request hash / version
does not match the stored file, or the x-fylr-signature is
invalid or expired. This endpoint returns no 401; a missing or
invalid token is treated as an anonymous request.
The addressed file id does not exist. A wrong hash, wrong
version, or an invalid / expired signature is a 403, not
a 404.
{
"@context": "http://iiif.io/api/image/2/context.json",
"@id": "https://example.com",
"protocol": "http://iiif.io/api/image",
"width": 1,
"height": 1,
"profile": [],
"tiles": [
{
"width": 1,
"height": 1,
"scaleFactors": [
1
]
}
],
"sizes": [
{
"width": 1,
"height": 1
}
],
"service": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}HEAD /eas/iiif/{fileId}/{hash}/obj_uuid/{obj_uuid}/{x-fylr-signature}/{version}/info.json
Same access checks as GET (and the same 403 / 404
responses; there is no 401), but returns no body on success.
Access token in the Authorization header:
Authorization: Bearer <token>.
The ID of the file.
The hash is the file.hash as described here.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs.
The file.class_extension as described here.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs. The signature will be taken from the query parameter first and if not found, from the request header.
The signature to omit file permission checks. It will be added to the URL when
retrieved through /api/db, /api/search or other endpoints which deliver
fylr URLs. The signature will be taken from the query parameter first and if
not found, from the request header.
The image information exists and is accessible. No response body.
No content
Access to the file is denied (code InsufficientRights):
the caller holds neither asset_show nor asset_download on the
file (holding either one is enough; anonymous requests are checked
against the deep_link user), or the request hash / version
does not match the stored file, or the x-fylr-signature is
invalid or expired. This endpoint returns no 401; a missing or
invalid token is treated as an anonymous request.
The addressed file id does not exist. A wrong hash, wrong
version, or an invalid / expired signature is a 403, not
a 404.
No content
GET /eas/iiif/{fileId}/{hash}/obj_uuid/{obj_uuid}/{version}/info.json
The IIIF endpoint serves images and tiles.
Access token in the Authorization header:
Authorization: Bearer <token>.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs. The signature will be taken from the query parameter first and if not found, from the request header.
The signature to omit file permission checks. It will be added to the URL when
retrieved through /api/db, /api/search or other endpoints which deliver
fylr URLs. The signature will be taken from the query parameter first and if
not found, from the request header.
Contains the IIIF image information.
IIIF Image API 2.0 image information document — the standard
reply to a /info.json request, defined by the IIIF Image API
2.0 specification.
fylr serves this document so any IIIF-aware client (Mirador, Universal Viewer, OpenSeadragon, ...) can discover the image's dimensions, supported tile sizes and feature profile.
JSON-LD context — always the IIIF Image API 2 URL.
The image's IIIF service URL — /info.json without the
/info.json suffix.
The IIIF protocol URI.
The image's native width, in pixels.
The image's native height, in pixels.
Access to the file is denied (code InsufficientRights):
the caller holds neither asset_show nor asset_download on the
file (holding either one is enough; anonymous requests are checked
against the deep_link user), or the request hash / version
does not match the stored file, or the x-fylr-signature is
invalid or expired. This endpoint returns no 401; a missing or
invalid token is treated as an anonymous request.
The addressed file id does not exist. A wrong hash, wrong
version, or an invalid / expired signature is a 403, not
a 404.
{
"@context": "http://iiif.io/api/image/2/context.json",
"@id": "https://example.com",
"protocol": "http://iiif.io/api/image",
"width": 1,
"height": 1,
"profile": [],
"tiles": [
{
"width": 1,
"height": 1,
"scaleFactors": [
1
]
}
],
"sizes": [
{
"width": 1,
"height": 1
}
],
"service": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}HEAD /eas/iiif/{fileId}/{hash}/obj_uuid/{obj_uuid}/{version}/info.json
Same access checks as GET (and the same 403 / 404
responses; there is no 401), but returns no body on success.
Access token in the Authorization header:
Authorization: Bearer <token>.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs. The signature will be taken from the query parameter first and if not found, from the request header.
The signature to omit file permission checks. It will be added to the URL when
retrieved through /api/db, /api/search or other endpoints which deliver
fylr URLs. The signature will be taken from the query parameter first and if
not found, from the request header.
The image information exists and is accessible. No response body.
No content
Access to the file is denied (code InsufficientRights):
the caller holds neither asset_show nor asset_download on the
file (holding either one is enough; anonymous requests are checked
against the deep_link user), or the request hash / version
does not match the stored file, or the x-fylr-signature is
invalid or expired. This endpoint returns no 401; a missing or
invalid token is treated as an anonymous request.
The addressed file id does not exist. A wrong hash, wrong
version, or an invalid / expired signature is a 403, not
a 404.
No content
GET /eas/iiif/{fileId}/{hash}/{x-fylr-signature}/{version}/info.json
The IIIF endpoint serves images and tiles.
Access token in the Authorization header:
Authorization: Bearer <token>.
The ID of the file.
The hash is the file.hash as described here.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs.
The file.class_extension as described here.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs. The signature will be taken from the query parameter first and if not found, from the request header.
The signature to omit file permission checks. It will be added to the URL when
retrieved through /api/db, /api/search or other endpoints which deliver
fylr URLs. The signature will be taken from the query parameter first and if
not found, from the request header.
Contains the IIIF image information.
IIIF Image API 2.0 image information document — the standard
reply to a /info.json request, defined by the IIIF Image API
2.0 specification.
fylr serves this document so any IIIF-aware client (Mirador, Universal Viewer, OpenSeadragon, ...) can discover the image's dimensions, supported tile sizes and feature profile.
JSON-LD context — always the IIIF Image API 2 URL.
The image's IIIF service URL — /info.json without the
/info.json suffix.
The IIIF protocol URI.
The image's native width, in pixels.
The image's native height, in pixels.
Access to the file is denied (code InsufficientRights):
the caller holds neither asset_show nor asset_download on the
file (holding either one is enough; anonymous requests are checked
against the deep_link user), or the request hash / version
does not match the stored file, or the x-fylr-signature is
invalid or expired. This endpoint returns no 401; a missing or
invalid token is treated as an anonymous request.
The addressed file id does not exist. A wrong hash, wrong
version, or an invalid / expired signature is a 403, not
a 404.
{
"@context": "http://iiif.io/api/image/2/context.json",
"@id": "https://example.com",
"protocol": "http://iiif.io/api/image",
"width": 1,
"height": 1,
"profile": [],
"tiles": [
{
"width": 1,
"height": 1,
"scaleFactors": [
1
]
}
],
"sizes": [
{
"width": 1,
"height": 1
}
],
"service": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}HEAD /eas/iiif/{fileId}/{hash}/{x-fylr-signature}/{version}/info.json
Same access checks as GET (and the same 403 / 404
responses; there is no 401), but returns no body on success.
Access token in the Authorization header:
Authorization: Bearer <token>.
The ID of the file.
The hash is the file.hash as described here.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs.
The file.class_extension as described here.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs. The signature will be taken from the query parameter first and if not found, from the request header.
The signature to omit file permission checks. It will be added to the URL when
retrieved through /api/db, /api/search or other endpoints which deliver
fylr URLs. The signature will be taken from the query parameter first and if
not found, from the request header.
The image information exists and is accessible. No response body.
No content
Access to the file is denied (code InsufficientRights):
the caller holds neither asset_show nor asset_download on the
file (holding either one is enough; anonymous requests are checked
against the deep_link user), or the request hash / version
does not match the stored file, or the x-fylr-signature is
invalid or expired. This endpoint returns no 401; a missing or
invalid token is treated as an anonymous request.
The addressed file id does not exist. A wrong hash, wrong
version, or an invalid / expired signature is a 403, not
a 404.
No content
GET /eas/iiif/{fileId}/{hash}/{version}/info.json
The IIIF endpoint serves images and tiles.
Access token in the Authorization header:
Authorization: Bearer <token>.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs. The signature will be taken from the query parameter first and if not found, from the request header.
The signature to omit file permission checks. It will be added to the URL when
retrieved through /api/db, /api/search or other endpoints which deliver
fylr URLs. The signature will be taken from the query parameter first and if
not found, from the request header.
Contains the IIIF image information.
IIIF Image API 2.0 image information document — the standard
reply to a /info.json request, defined by the IIIF Image API
2.0 specification.
fylr serves this document so any IIIF-aware client (Mirador, Universal Viewer, OpenSeadragon, ...) can discover the image's dimensions, supported tile sizes and feature profile.
JSON-LD context — always the IIIF Image API 2 URL.
The image's IIIF service URL — /info.json without the
/info.json suffix.
The IIIF protocol URI.
The image's native width, in pixels.
The image's native height, in pixels.
Access to the file is denied (code InsufficientRights):
the caller holds neither asset_show nor asset_download on the
file (holding either one is enough; anonymous requests are checked
against the deep_link user), or the request hash / version
does not match the stored file, or the x-fylr-signature is
invalid or expired. This endpoint returns no 401; a missing or
invalid token is treated as an anonymous request.
The addressed file id does not exist. A wrong hash, wrong
version, or an invalid / expired signature is a 403, not
a 404.
{
"@context": "http://iiif.io/api/image/2/context.json",
"@id": "https://example.com",
"protocol": "http://iiif.io/api/image",
"width": 1,
"height": 1,
"profile": [],
"tiles": [
{
"width": 1,
"height": 1,
"scaleFactors": [
1
]
}
],
"sizes": [
{
"width": 1,
"height": 1
}
],
"service": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}HEAD /eas/iiif/{fileId}/{hash}/{version}/info.json
Same access checks as GET (and the same 403 / 404
responses; there is no 401), but returns no body on success.
Access token in the Authorization header:
Authorization: Bearer <token>.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs. The signature will be taken from the query parameter first and if not found, from the request header.
The signature to omit file permission checks. It will be added to the URL when
retrieved through /api/db, /api/search or other endpoints which deliver
fylr URLs. The signature will be taken from the query parameter first and if
not found, from the request header.
The image information exists and is accessible. No response body.
No content
Access to the file is denied (code InsufficientRights):
the caller holds neither asset_show nor asset_download on the
file (holding either one is enough; anonymous requests are checked
against the deep_link user), or the request hash / version
does not match the stored file, or the x-fylr-signature is
invalid or expired. This endpoint returns no 401; a missing or
invalid token is treated as an anonymous request.
The addressed file id does not exist. A wrong hash, wrong
version, or an invalid / expired signature is a 403, not
a 404.
No content
GET /eas/iiif/{fileId}/{hash}/obj_uuid/{obj_uuid}/{x-fylr-signature}/{version} — Redirect to the IIIF info.json.
A IIIF resource URL with no trailing path segment (with or without
a trailing slash) is 303-redirected to the corresponding
info.json. No access check is performed at this step; the rights
are checked on the redirected info.json request.
Access token in the Authorization header:
Authorization: Bearer <token>.
The ID of the file.
The hash is the file.hash as described here.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs.
The file.class_extension as described here.
Redirects to <this-url>/info.json via a Location header.
Redirects to <this-url>/info.json via a Location header.
No content
HEAD /eas/iiif/{fileId}/{hash}/obj_uuid/{obj_uuid}/{x-fylr-signature}/{version} — Redirect to the IIIF info.json.
Like GET on this redirect URL: 303-redirected to the
corresponding info.json.
Access token in the Authorization header:
Authorization: Bearer <token>.
The ID of the file.
The hash is the file.hash as described here.
The _uuid of the object the file is linked into. This is used for the permission check.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs.
The file.class_extension as described here.
Redirects to <this-url>/info.json via a Location header.
Redirects to <this-url>/info.json via a Location header.
No content
GET /eas/iiif/{fileId}/{hash}/obj_uuid/{obj_uuid}/{version} — Redirect to the IIIF info.json.
A IIIF resource URL with no trailing path segment (with or without
a trailing slash) is 303-redirected to the corresponding
info.json. No access check is performed at this step; the rights
are checked on the redirected info.json request.
Access token in the Authorization header:
Authorization: Bearer <token>.
Redirects to <this-url>/info.json via a Location header.
Redirects to <this-url>/info.json via a Location header.
No content
HEAD /eas/iiif/{fileId}/{hash}/obj_uuid/{obj_uuid}/{version} — Redirect to the IIIF info.json.
Like GET on this redirect URL: 303-redirected to the
corresponding info.json.
Access token in the Authorization header:
Authorization: Bearer <token>.
Redirects to <this-url>/info.json via a Location header.
Redirects to <this-url>/info.json via a Location header.
No content
GET /eas/iiif/{fileId}/{hash}/{x-fylr-signature}/{version} — Redirect to the IIIF info.json.
A IIIF resource URL with no trailing path segment (with or without
a trailing slash) is 303-redirected to the corresponding
info.json. No access check is performed at this step; the rights
are checked on the redirected info.json request.
Access token in the Authorization header:
Authorization: Bearer <token>.
The ID of the file.
The hash is the file.hash as described here.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs.
The file.class_extension as described here.
Redirects to <this-url>/info.json via a Location header.
Redirects to <this-url>/info.json via a Location header.
No content
HEAD /eas/iiif/{fileId}/{hash}/{x-fylr-signature}/{version} — Redirect to the IIIF info.json.
Like GET on this redirect URL: 303-redirected to the
corresponding info.json.
Access token in the Authorization header:
Authorization: Bearer <token>.
The ID of the file.
The hash is the file.hash as described here.
The signature to omit file permission checks. It will be added to the URL when retrieved through /api/db, /api/search or other endpoints which deliver fylr URLs.
The file.class_extension as described here.
Redirects to <this-url>/info.json via a Location header.
Redirects to <this-url>/info.json via a Location header.
No content
GET /eas/iiif/{fileId}/{hash}/{version} — Redirect to the IIIF info.json.
A IIIF resource URL with no trailing path segment (with or without
a trailing slash) is 303-redirected to the corresponding
info.json. No access check is performed at this step; the rights
are checked on the redirected info.json request.
Access token in the Authorization header:
Authorization: Bearer <token>.
Redirects to <this-url>/info.json via a Location header.
Redirects to <this-url>/info.json via a Location header.
No content
HEAD /eas/iiif/{fileId}/{hash}/{version} — Redirect to the IIIF info.json.
Like GET on this redirect URL: 303-redirected to the
corresponding info.json.
Access token in the Authorization header:
Authorization: Bearer <token>.
Redirects to <this-url>/info.json via a Location header.
Redirects to <this-url>/info.json via a Location header.
No content
URL templates
These GET, HEAD endpoints embed parameters inside a path segment (e.g. {quality}.{format}), which the interactive API panel can't render — they are listed here as URL templates instead. All live under the /api/v1 base path.
Path parameters
fileId— The ID of the file.hash— Thehashis thefile.hashas described here.obj_uuid— The_uuidof the object the file is linked into. This is used for the permission check.x-fylr-signature— The signature to omit file permission checks. It will be added to the URL when retrieved through/api/db,/api/searchor other endpoints which deliver fylr URLs.version— Thefile.class_extensionas described here.region— The IIIF region is a string withx,y,w,hand other format. Check the link for more information.size— The IIIF size parameter determines the dimensions to which the extracted region is to be scaled. Check the link for more information.rotation— The IIIF rotation specifies mirroring and rotation. A leading exclamation mark (“!”) indicates that the image should be mirrored by reflection on the vertical axis before any rotation is applied. The numerical value represents the number of degrees of clockwise rotation, and may be any number from 0 to 360. fylr only supports integer numbers for rotation. More information can be found in the link.quality— The IIIF format parameter determines whether the image is delivered in color, grayscale or black and white. Click on the link for more information.format— The IIIF size parameter determines the dimensions to which the extracted region is to be scaled. Check the link for more information. Formatsjpgandpngare delivered with fast code if the quality is set tocolorordefaultand norotationis requested.
Last updated