APIs
Overview
CollectiveAccess offers several web-based APIs for data access and manipulation:
JSON API (Legacy)
Collective Access provides a REST API (Representational State Transfer Application Programming Interface). Short of very few HTTP GET parameters, both the request parameters and the responses are encoded in JSON.
IIIF
The International Image Interoperability Framework (IIIF) Image service is a standard for describing and delivering images via http. The CollectiveAccess IIIF Image API returns images in response to a web request. Request URIs can specify cropping, size, rotation, quality and format of the returned image, as well as request technical information about the image. This service is often used to support advanced image viewing and presentation applications. CollectiveAccess uses this service internally to enable use of IIIF-compliant image and document viewers such as Mirador, UniversalViewer and DivaJS.
OAI-PMH
Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH) service: A read-only API used to disseminate metadata to other systems in a widely supported, standards-compliant manner. CollectiveAccess can publish data in formats defined by an export mapping for use by OAI-PMH clients.
API Models and Tables
Each table in the CollectiveAccess database has a corresponding model class. Model classes provide functionality that eases reading, editing and writing data to its table, including: