Skip to main content

API Reference

Every feature available through the Rednal interface is also available programmatically. The REST API provides access to collections, documents, metadata, search, content delivery, and interoperability endpoints.

Documentation in Progress

This section is being written as part of Rednal's transition to open source. Full API reference documentation will be published alongside the public repository.

What's Covered​

This section will document the complete REST API:

  • Collections — Create, read, update, and organize collections and sub-collections
  • Documents — Manage documents, pages, and associated metadata
  • Search — Full-text and metadata queries with filtering and pagination
  • IIIF — Image API and Presentation API endpoints
  • Users — Authentication, profiles, and permissions
  • Assets — Upload, process, and retrieve digital objects

Interoperability​

Rednal supports established standards for sharing and harvesting metadata across institutions:

  • OAI-PMH — Open Archives Initiative Protocol for Metadata Harvesting
  • JSON-LD — Linked Data serialization for semantic interoperability
  • Dublin Core (DC) — Core metadata element set for cross-domain resource description
  • MARC — Machine-Readable Cataloging for library system integration

On This Page