edge-patron

Copyright (C) 2018-2022 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.

Introduction

Edge API to interface with FOLIO for 3rd party discovery services to allow patrons to perform self-service actions (place holds, renewals, etc)

Overview

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 Discovery Service (EDS) in mind and the patron empowerment portion of the RTAC service. Paton empowerment allows patrons to perform self-service actions such as manage their holds, renewals, etc.

Security

The edge-patron API is secured via the facilities provided by edge-common. More specifically, via API Key. See edge-common for additional details.

Required Permissions

Institutional users should be granted the following permissions in order to use this edge API:

• patron.all
• users.collection.get
• circulation.requests.item.get

Configuration

Configuration information is specified in two forms:

1. System Properties - General configuration
2. Properties File - Configuration specific to the desired secure store

System Properties

Property	Default	Description
port	8081	Server port to listen on
okapi_url	required	Where to find Okapi (URL)
secure_store	Ephemeral	Type of secure store to use. Valid: Ephemeral, AwsSsm, Vault
secure_store_props	NA	Path to a properties file specifying secure store configuration
token_cache_ttl_ms	3600000	How long to cache JWTs, in milliseconds (ms)
null_token_cache_ttl_ms	30000	How long to cache login failures (null JWTs), in milliseconds (ms)
token_cache_capacity	100	Max token cache size
patron_id_cache_ttl_ms	3600000	How long to cache patron ID mappings in milliseconds (ms)
null_patron_id_cache_ttl_ms	30000	How long to cache patron lookup failures in milliseconds (ms)
patron_id_cache_capacity	1000	Max token cache size
log_level	INFO	Log4j Log Level
request_timeout_ms	30000	Request Timeout

Patron Mapping

In order to map external patron IDs to those used within FOLIO, the externalSystemId field in the user metadata is used. The mapping flow works like this:

1. A request arrives containing an external system's patron ID
2. The patron ID cache is consulted. If a mapping has been cached, skip to #5.
3. A request is made to mod-users, querying for the user having the provided externalSystemId
4. The external ID -> internal/FOLIO ID mapping is cached for a configurable amount of time.
5. The internal/FOLIO ID is used when calling mod-patron

Additional information

Issue tracker

See project EDGPATRON at the FOLIO issue tracker.

Other documentation

Other modules are described, with further FOLIO Developer documentation at dev.folio.org