Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The flow descriptions and diagrams below reference the OTM Bridge API Specification and OTM Repository Gateway Specification

Summary

The One To Many (OTM) Specification defines two APIs for the communication between a Repository and a Distributed Digital Preservation system (DDP) in order to facilitate depositing, deletion, restoration, and auditing of digital preservation assets. The APIs defined are the OTM Repository Gateway API (Gateway) for the Repository and the OTM Bridge API (Bridge) for the DDP. The Gateway and the Bridge APIs handle intermediary communication between the Repository and DDP and allow each system to operate without any knowledge of the internals of the other system. Each API is designed so that they can be deployed alongside the Repository and DDP as an additional service which can be offered. They provide an HTTP based approach for authentication, communication, and transfer of data.

Info
titlediscussion
  • digital preservation assets? data? bitstreams?
  • wording for the deployment feels a bit clumsy to me ("Each api..."). possibility for refinement imo.
    • have it be less about offering an additional service and more about why we made this decision


Initialize

Flow

  1. An agreement is reached between a repository owner and DDP system that will allow repository content to be deposited into the DDP; appropriate SLA/MOU and other legal documentation is signed and arrangements for billing/invoicing are made
  2. The DDP administrator calls the Bridge Add Account endpoint to add the repository to the Bridge system and generate the credentials needed for the repository's Gateway to connect to the Bridge
  3. The DDP administrator provides the Bridge credentials to the Gateway administrator
  4. The Gateway administrator enters the Bridge credentials into the Gateway (method TBD) and the Gateway calls the Bridge Register endpoint to provide the Bridge with the details necessary to make calls back to the Gateway

...