Mercurial > hg > digilib
comparison doc/src/site/markdown/iiif-api.md @ 1396:7a2de95a7b8e
documentation updated with Ubbo's codec tuning tips and IIIF API info.
| author | robcast |
|---|---|
| date | Fri, 09 Oct 2015 16:45:40 +0200 |
| parents | |
| children | a244753f8f33 |
comparison
equal
deleted
inserted
replaced
| 1395:4c72696fcc96 | 1396:7a2de95a7b8e |
|---|---|
| 1 # The digilib IIIF API | |
| 2 | |
| 3 The Scaler servlet provides not only its native [Scaler API](scaler-api.html) but also an API compliant to the standards of the International Image Interoperability Framework http://iiif.io. | |
| 4 | |
| 5 As of version 2.3 digilib supports the [IIIF Image API version 1.1](http://iiif.io/api/image/1.1/) at [compliance level 2](http://iiif.io/api/image/1.1/compliance.html) (except for forced w,h sizes where the image would be distorted). | |
| 6 | |
| 7 IIIF Image API URLs for an image request have the form: | |
| 8 | |
| 9 http[s]://server/digilib-webapp/Scaler/iiif-prefix/identifier/region/size/rotation/quality[.format] | |
| 10 | |
| 11 where `digilib-webapp` is the name of the digilib web application in the servlet container. | |
| 12 | |
| 13 The value of `iiif-prefix` is defined by the `iiif-prefix` parameter in the [digilib-config](digilib-config.html). The default value is "IIIF". | |
| 14 | |
| 15 The `identifier` part of the URL must not contain slashes. Since the identifier is mapped to the digilib fn-parameter, which is a filesystem path that likely contains slashes separating subdirectories, all occurrences of a slash have to be replaced by the value of the `iiif-slash-replacement` parameter in [digilib-config](digilib-config.html). The default value of the replacement string is "!", so the fn-path "books/book1/page0002" becomes the identifier "books!book1!page0002". | |
| 16 | |
| 17 For a definition of the other request parameters `region`, `size`, `rotation`, `quality`, and `format` please see the [IIIF Image API docs](http://iiif.io/api/image/1.1/). | |
| 18 | |
| 19 A IIIF Image API image request URL could look like: | |
| 20 | |
| 21 http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/full/!150,75/0/native.jpg | |
| 22 | |
| 23 An info request URL for the same image looks like: | |
| 24 | |
| 25 http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/info.json |