Copyright (C) 2018-2019 The Open Library Foundation
This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.
Edge API to interface with FOLIO for 3rd party discovery services to determine holdings availability.
The purpose of this edge API is to bridge the gap between 3rd party discovery services and FOLIO. More specifically, the initial implementation was built with EBSCO's Real Time Availability Check (RTAC) service in mind. RTAC is used by the EBSCO Discovery Service (EDS) to obtain up-to-date holdings information (status, call number, location, due date, etc.).
In order to reduce the amount of integration work on the discovery side, the API implemented here mimics an existing RTAC integration. This includes the parameter names, data formats, API endpoint names, among other things. There are certain quirks about the API being mimicked that may seem unintuitive, such as failures of any sort still result in 200 response, but with an empty
<holdings/> XML payload. Eventually all this will be documented.
See edge-common for a description of the security model.
Institutional users should be granted the following permission in order to use this edge API:
- See edge-common for a description of how configuration works.
- See FOLIO-2835: Following the 2.1.0 release, the nginx proxy for edge modules in the environments needs to be able to route to two different paths on the edge-rtac module: