Private image (Unit Access Only)

~~Attach a JWT to the request as the Authorization header. To encode it, each unit will share a “secret” (see ENV['YPM_SECRET'] in the code below) with ITS.~~ A ruby example for creating JWT

Send an API key to the request as a bearer token in the Authorization header. Each unit will share an API key (see ENV['YPM_SECRET'] in the code below) with ITS.

A curl example:

Code Block

language	ruby

require 'net/http'
require 'jwt'

# shared symmetric secret key to encrypt and decrypt the token
hmac_secret = ENV['YPM_SECRET']

payload = {
  unit: "YPM",
  iat: Time.now.to_i
}
token = JWT.encode payload, hmac_secret, 'HS512'
uri = URI("http://localhost:8182curl -O -H 'Authorization: Bearer TOKEN' 'http://images-dev.collections.yale.edu/iiif/2/ypm:85f1f218-30c1-48a4-8546-17d681f59c35.tif/full/20,/0/default.jpg")

req = Net::HTTP::Get.new(uri)
req['Authorization'] = "Bearer #{token}"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end

open('out.jpg', 'w') do |f|
  f.write(res.read_body)
end

Getting Stock TIFF Images

Code Block
https://media.collections.yale'

with TOKEN replaced with the actual value of the API key

An example in Ruby:

Code Block

language	ruby

require 'net/http'

uri = URI('http://images-dev.collections.yale.edu/iiif/2/ypm:85f1f218-30c1-48a4-8546-17d681f59c35.tif/full/20,/0/default.jpg')
api_key = ENV['YPM_SECRET']

req = Net::HTTP::Get.new(uri)
req['Authorization'] = "Bearer #{api_key}"

res = Net::HTTP.start(uri.hostname, uri.port,
                      use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end

open('out.jpg', 'w') do |f|
  f.write(res.read_body)
end

Getting Stock TIFF Images

Code Block
https://media.collections.yale.edu/tiff/{unit}/{uuid}.tif

...

Ingest of Images and Image Data

...

TMAN Database

...

production: traffic-manager-prd.cnh4zslmvwh7.us-east-1.rds.amazonaws.com:1433
development: traffic-manager-dev.c7exm1chla3f.us-east-1.rds.amazonaws.com:1433

New Database Fields

cds_access_master (type string, default: N): N (no access) or P (public)
cds_access_tiff (type string, default: N): N or P
cds_access_jpeg (type string, default N): N, U (unit access), or P
cds_maxsize_tiff (type integer, default: 0)
cds_maxsize_jpeg (type integer, default: 0)

...

507	Image processing was successful. Manifest builder has been notified to update the manifest for the content.
607	Image processing failed.
807	Image processing was successful and the manifest for the content has been updated.
907	Image processing was successful but manifest build failed.

...

Ingest of Object Data via Activity Stream

Metadata for objects to be delivered in the form of IIIF manifests gets harvested by CDS2 harvester. Each unit should implement an activity stream for that. We will use a subset of the protocol defined in IIIF Change Discovery API.

...

The stream is to be published via HTTP(s).
As long as it follows the API, the implementation detail is not important. For example, it can be an application that accommodates HTTP GET requests, or it can be a set of files served from an HTTP addressable store such as S3.
All data to be downloaded and parsed by the harvester MUST be encoded in UTF-8.

Collection

Example

...

A collection is the highest level document that (recursively) contains links to all other necessary documents. The harvester only has to know the URL of the collection.

Example

Code Block

{
  "@context": "http://iiif.io/api/discovery/0/context.json",
  "id": "https://example.org/activities/collection.json",
  "type": "OrderedCollection",
  "first": {
    "id": "https://example.org/activities/p1.json",
    "type": "OrderedCollectionPage"
  },
  "last": {
    "id": "https://example.org/activities/p3.json",
    "type": "OrderedCollectionPage"
  }
}

...

Document ("object") referenced by an activity item in the page document. It contains the real data for the object in question.

Example

Code Block

{
  "unit": "YCBA",
  "cmsType": "obj",
  "cmsId": "1726",
  "metadata": [
    {
      "label": "logo",
      "value": "https://static.britishart.yale.edu/images/ycba_logo.jpg"
    },
    {
      "label": "label",
      "value": "Robert Dighton, 1752–1814, British, The Produce of Industry, undated"
    },
    {
      "label": "AttributionRights URI",
      "value": "Yale Center for British Art, Paul Mellon Collection, public domainhttps://creativecommons.org/publicdomain/zero/1.0/"
    },
    {
      "label": "licenseRights Description",
      "value": "http://hdl.handle.net/10079/w6m90dq"
    },
    {
      "label": "Description",
      "value": "Twelve Illustrations to Contemporary Life and Diversions, Sheet: 6 5/8 × 10 7/8 inches (16.8 × 27.6 cm)Metadata describing Yale Center for British Art collections is public domain under CC0. Copyright or other restrictions may apply to cultural works or images of those works in this record."
    },
     {
      "label": "CreatorCopyright Statement",
      "value": "Robert Dighton, 1752–1814, BritishCopyright Information"
    },
    {
      "label": "TitleImage Use Rights URI",
      "value": "The Produce of Industryhttp://rightsstatements.org/vocab/UND/1.0/"
    },
    {
      "label": "PhysicalImage Use DescriptionRights",
      "value": "SheetCopyright Undetermined: 6The 5/8copyright ×and 10related 7/8rights inches (16.8 × 27.6 cm)"
    },
    {
      "label": "Credit Line",
      "value": "Yale Center for British Art, Paul Mellon Collection"
    },
    {
      "label": "Institution",
      "value": "Yale Center for British Artstatus of this Item has been reviewed by the organization that has made the Item available, but the organization was unable to make a conclusive determination as to the copyright status of the Item. Please refer to the organization that has made the Item available for more information. You are free to use this Item in any way that is permitted by the copyright and related rights legislation that applies to your use."
    },
    {
      "label": "CollectionAttribution",
      "value": "Prints and DrawingsYale Center for British Art, Paul Mellon Collection, public domain"
    },
    {
      "label": "Call NumberDescription",
      "value": "B1986.29.81"
    },
  Twelve Illustrations to Contemporary Life and Diversions, Sheet: 6 5/8 × 10 7/8 inches (16.8 × 27.6 cm)"
    },
    {
      "label": "homepageCreator",
      "value": ["Robert Dighton, 1752–1814, British"
    },
{    {
      "@idlabel": "https://collections.britishart.yale.edu/catalog/tms:1726",
     "Title",
      "labelvalue": "catalogThe entryProduce atof theIndustry"
Yale Center for British Art"},
    {
      "formatlabel": "text/html"Physical Description",
      "value": "Sheet: }6 5/8 × 10 7/8 inches (16.8 ×  ]27.6 cm)"
    },
    {
      "label": "seeAlsoCredit Line",
      "value": [ "Yale Center for British Art, Paul Mellon Collection"
    },
    {
      "label": "Institution",
      "@idvalue": "https://collections.britishart.yale.edu/oaicatmuseum/OAIHandler?verb=GetRecord&identifier=oai:tms.ycba.yale.edu:1726&metadataPrefix=lido",Yale Center for British Art"
    },
    {
      "formatlabel": "text/xmlCollection",
   
      "profilevalue": "http://www.lido-schema.org/schema/v1.0/lido-v1.0.xsd"
   Prints and Drawings"
    },
    {
    {  "label": "Call Number",
      "@idvalue": "http://collection.britishart.yale.edu/id/page/object/1726",B1986.29.81"
    },
    {
      "formatlabel": "homepage",
      "text/rdf+n3"value": [
        {
    }       ]"@id": "https://collections.britishart.yale.edu/catalog/tms:1726",
    }
  ]
}

Attributes

...

metadata

...

      "type": "Text",
          "label": "catalog entry at the Yale Center for British Art",
          "format": "text/html"
        }
      ]
    },
    {
      "label": "seeAlso",
      "value": [
        {
          "@id": "https://collections.britishart.yale.edu/oaicatmuseum/OAIHandler?verb=GetRecord&identifier=oai:tms.ycba.yale.edu:1726&metadataPrefix=lido",
          "type": "Dataset",
          "format": "text/xml",
          "profile": "http://www.lido-schema.org/schema/v1.0/lido-v1.0.xsd"
        },
        {
          "@id": "http://collection.britishart.yale.edu/id/page/object/1726",
          "format": "text/rdf+n3"
        }
      ]
    }
  ]
}

Attributes


unit, cmsType, cmsId		These three values together uniquely defines an object, corresponding respectively to unitcode, cmstype, and cmsid in the dbo.assets table of TMAN database.
metadata		An ordered list of items, each of which has a "label" and a "value". All entries are optional, except "label", "logo", and "Attribution" are required. Any combinations of “label” and “values” can be added here, and each item will be added to the top level “metadata” field of the manifest as it is, with the exception of the “special” labels below, which are interpreted differently.
	label	becomes the “label” for the whole manifest
	Rights URI	goes to the top level “rights” field
	Rights Description	goes into the top level “requiredStatement” field
	Copyright Statement
	Image Use Rights URI
	Image Use Rights
	logo	goes to the top level “logo” field
	homepage, seeAlso	goes to the top level “homepage”, “seeAlso” field respectively. Since these can have great variability among units, this field should be entered verbatim as should appear in the manifest, according to the API. See https://iiif.io/api/presentation/3.0/#homepage https://iiif.io/api/presentation/3.0/#seealso

Version	Old Version 32	New Version Current
Changes made by	Seong-June Kim	Seong-June Kim
Saved on	Aug 17, 2020	May 19, 2021

Versions Compared

Key

Private image (Unit Access Only)

Getting Stock TIFF Images

Getting Stock TIFF Images

Ingest of Images and Image Data

New Database Fields

Ingest of Object Data via Activity Stream

Collection

Example

Example

Example

Attributes

Attributes

Content Comparison

Versions Compared

Key

Private image (Unit Access Only)

Getting Stock TIFF Images

Getting Stock TIFF Images

Ingest of Images and Image Data

New Database Fields

Ingest of Object Data via Activity Stream

Collection

Example

Example

Example

Attributes

Attributes