OpenRiC Reference API

Integration Discovery AGPL-3.0 Open source

Reference Laravel implementation of the OpenRiC HTTP contract — 46 endpoints, full RiC-O 1.1 8-entity CRUD, OAI-PMH v2.0, auto-generated OpenAPI 3.0.

Description

OpenRiC Reference API is the canonical implementation of the OpenRiC HTTP contract on top of RiC-O 1.1. It exposes Records, Agents, Places, Rules, Activities, Instantiations, Repositories and Functions through a uniform CRUD surface, plus OAI-PMH v2.0 for harvesting and content negotiation for JSON-LD/Turtle/HTML. Any OpenRiC-conformant client (viewer, capture, third-party) can drive this server, and any other server that implements the contract can replace it without client changes. Hosted reference deployment at ric.theahg.co.za.
Source Code
https://github.com/openric/service
Default branch: main Public
GLAM Sectors
Archive Library Museum Gallery Dam
Schema & ERDs 33
  • AHG Settings
    Centralized AHG plugin settings management (section-based admin UI).
    ahgSettingsPlugin
    core
  • AI & NER
    Named Entity Recognition, translation, summarization, spellcheck, face detection, LLM suggestions.
    ahgAIPlugin
    ai
  • Audit Trail
    Audit logging for all entity changes with field-level detail tracking.
    ahgAuditTrailPlugin
    compliance
  • CDPA (Zimbabwe)
    Cyber & Data Protection Act [Chapter 12:07] — POTRAZ compliance.
    ahgCDPAPlugin
    compliance
  • Condition Assessment
    Spectrum 5.1-aligned condition assessment with treatment proposals and photo documentation.
    ahgConditionPlugin
    collection
  • Custom Fields (EAV)
    Admin-configurable custom metadata fields using Entity-Attribute-Value pattern.
    ahgCustomFieldsPlugin
    core
  • Data Ingest
    OAIS-aligned 6-step batch ingestion pipeline with AI processing.
    ahgIngestPlugin
    ingest
  • Digital Asset Management
    Digital Asset Management with IPTC metadata, watermarks, and asset workflows.
    ahgDAMPlugin
    sector
  • Digital Preservation
    PREMIS events, checksums, fixity verification, format registry, PRONOM sync, replication.
    ahgPreservationPlugin
    core
  • DOI Integration
    DataCite DOI minting, queue processing, verification, and sync.
    ahgDoiPlugin
    integration
  • Donor Agreements
    Donor/institution agreement management with SA regulatory compliance.
    ahgDonorAgreementPlugin
    collection
  • Exhibition Management
    Exhibition planning, object loans, venue management for GLAM/DAM institutions.
    ahgExhibitionPlugin
    exhibition
  • Extended Contacts
    Extended contact information for actors (phone, email, address, social media).
    ahgContactPlugin
    collection
  • Extended Rights
    RightsStatements.org, embargo management, TK Labels, and batch rights operations.
    ahgExtendedRightsPlugin
    rights
  • Extension Management
    Core extension/plugin management system: plugin registry, extension lifecycle, admin menus, settings, widgets, migrations, validation, data mapping, landing pages, ISBN lookup.
    atom-framework
    core
  • Gallery Management
    Gallery/exhibition management, artist tracking, loans, and provenance.
    ahgGalleryPlugin
    sector
  • Heritage Accounting
    GRAP 103 / IPSAS 45 heritage asset accounting with valuation and movement tracking.
    ahgHeritageAccountingPlugin
    compliance
  • IIIF Integration
    IIIF manifests, canvases, annotations, annotation bodies, and OCR text storage.
    ahgIiifPlugin
    core
  • Indigenous Cultural IP
    Indigenous Cultural & Intellectual Property management and TK Labels.
    ahgICIPPlugin
    rights
  • Library System — Full ILS
    Full Integrated Library System: cataloging, circulation, patron management, holds, fines, acquisitions, serials, interlibrary loan, OPAC, MARC import/export, heritage accounting (GRAP 103/IPSAS 45).
    ahgLibraryPlugin
    sector
  • Loan Management
    Incoming/outgoing loan tracking with item-level condition checks and insurance.
    ahgLoanPlugin
    collection
  • Museum Cataloging
    Museum cataloging with CCO, CIDOC-CRM, Spectrum 5.1, Getty vocabulary linking.
    ahgMuseumPlugin
    sector
  • NAZ (Zimbabwe)
    National Archives Act [Chapter 25:06] — 25-year rule, closure, permits.
    ahgNAZPlugin
    compliance
  • Privacy & Compliance
    POPIA/GDPR/CCPA compliance: breach management, consent tracking, SAR requests, data retention.
    ahgPrivacyPlugin
    compliance
  • Provenance Tracking
    Chain of custody and provenance event tracking for archival records.
    ahgProvenancePlugin
    collection
  • Report Builder
    Enterprise report builder with templates, sections, SQL queries, scheduling.
    ahgReportBuilderPlugin
    reporting
  • Research Portal
    Researcher registration, reading room booking, access requests, and usage logging.
    ahgResearchPlugin
    research
  • RiC / Fuseki
    Records in Context (RiC-O) triplestore integration with Apache Jena Fuseki.
    ahgRicExplorerPlugin
    integration
  • Security Classification
    Industry-aligned security classification, user clearance levels, and access control.
    ahgSecurityClearancePlugin
    compliance
  • Standards & Conformance
    Standards directory, Heratio extensions, vendor conformance declarations, and setup guides.
    ahgRegistryPlugin
    core
  • Table Relationships Summary
    Cross-plugin relationship map showing how all plugin tables link to AtoM core entities: information_object, repository, actor, digital_object, term/taxonomy, and user.
    crossPlugin
    core
  • User Feedback
    User feedback and suggestions management.
    ahgFeedbackPlugin
    research
  • Workflow Engine
    Configurable approval workflow with steps, assignments, and history.
    ahgWorkflowPlugin
    reporting
Details
Vendor