Understanding Aleph's REST API Middleware

Slide Note

Exploring the functionality and purpose of the API adapter for Aleph's REST API, this content delves into its design criteria, implementation, and use cases. Through a series of images and brief explanations, key aspects such as access configurations, insulation of systems, and network traffic optimization are highlighted. The middleware acts as a bridge between Aleph and external systems, enhancing operational efficiency and adaptability.

caer928 Follow

Uploaded on Oct 06, 2024 | 0 Views

Download Presentation

Please find below an Image/Link to download the presentation.

The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author. Download presentation by click this link. If you encounter any issues during the download, it is possible that the publisher has removed the file from their server.

E N D

Presentation Transcript

Good Fences Make Good Neighbors1 Middleware for Aleph s REST API Rich Wenger, E-resource Systems Manager MIT Libraries 1. Frost, Robert. Mending Wall Collected Poems of Robert Frost. New York, Henry Holt and Co., 1930. 47. Print

Agenda 1. Short review of Aleph XML APIs 2. What is the API adapter? 3. Why did we build it? 4. Design criteria 5. How does it work? 6. Use cases Aleph IGeLU 2014 Page 2

Aleph XML APIs: X-server 1. http://walter.mit.edu/X?op=bor-info&library=mit50&bor_id=rwenger@mit.edu 2. http://walter.mit.edu/X?op=bor-by-key&bor_id=rwenger@mit.edu Aleph IGeLU 2014 Page 3

Aleph XML APIs: REST* 1. http://walter.mit.edu:1891/rest-dlf/patron/50481/circulationActions/loans 2. http://walter.mit.edu:1891/rest-dlf/patron/164423/circulationActions/cash * REpresentational State Transfer - rest-web-services Aleph IGeLU 2014 Page 4

Aleph XML APIs Standard access configuration Aleph REST API External system Aleph IGeLU 2014 Page 5

What is the API adapter? 1. A thin layer of programming between the Aleph REST API and external systems that use the API. 2. A Perl program that runs from Aleph s cgi-bin directory. Aleph IGeLU 2014 Page 6

What is the API adapter? Access configuration with adapter installed Aleph REST API External system Adapter Aleph IGeLU 2014 Page 7

Why did we build it? To insulate Aleph and the calling system from each other, particularly in the case of a competing vendor. The software reflects the business model. To provide an avenue for problem circumvention that does not depend on either Aleph or the calling system. Aleph IGeLU 2014 Page 8

Why did we build it? To minimize the latency of network traffic by bringing multiple calls to the API inboard on the Aleph server instead of extending them across the network. APIs change over time and between releases. An intermediate layer can mask such changes unless or until they prove useful. Aleph IGeLU 2014 Page 9

Why did we build it? Simplifies access control. There is one place to whitelist external servers instead of multiple Aleph configuration files. Provides the flexibility to augment Aleph data from other local systems if so desired. Aleph IGeLU 2014 Page 10

Design the adapter should.. Integrate easily into the Aleph server environment. Have a small footprint and be unobtrusive in its operation. Return results ~identical to those generated by the Aleph REST API. before and after Aleph IGeLU 2014 Page 11

Design the adapter should.. Not interfere in any way with the standard use of the Aleph REST API through the Tomcat/JBOSS server and port. Consume Aleph REST API URL syntax without modification. Aleph IGeLU 2014 Page 12

Design the adapter should.. Function in a transparent pass-through mode for all REST API services except for those intentionally modified by the host site. Aleph IGeLU 2014 Page 13

How does it work? The adapter uses an Apache rewrite rule to direct REST URLs to itself running on port 80. The external system sends its REST calls to port 80 instead of 1891. The adapter parses the incoming URL and sends the request to the Aleph REST API via localhost . Output from the REST API is passed back to the caller after any desired processing. Aleph IGeLU 2014 Page 14

Use case 1, ID translation For patron functions, the REST API requires the patron s Aleph id. Few, if any, authentication systems return an Aleph id as an identifier. The REST API has no function to convert an alias to the corresponding Aleph id, but the X-server does. This forces calling systems to use two calls across the network instead of one, and two different API s. Aleph IGeLU 2014 Page 15

Calls to Aleph REST API without the adapter installed. Two calls. Aleph server Apache Ports 80, 443 JBOSS REST API Port 1891 X-server API http://walter.mit.edu/X?op=bor-by-key&bor_id=rwenger@mit.edu XML 50481 http://walter.mit.edu:1891/rest-dlf/patron/ External System

Calls to Aleph REST API with the adapter installed in passive mode. Two calls. Aleph server Apache Ports 80, 443 JBOSS REST API Port 1891 X-server API Adapter http://walter.mit.edu/X?op=bor-by-key&bor_id=rwenger@mit.edu XML 50481 http://walter.mit.edu/rest-dlf/patron/ External System

Calls to Aleph REST API with the adapter installed and using the X- server transparently. One call. Aleph server Apache Rewrite rule JBOSS REST API Port 1891 X-server API Adapter XML http://walter.mit.edu:1891/rest-dlf/patron/rwenger@mit.edu External System

Use case 2, data filtering When using the adapter with the X-server. The bor-info method returns historical data, including paid fines. The adapter can filter paid fines from the response XML. Aleph IGeLU 2014 Page 19

Good Fences Make Good Neighbors Maintain control of the terrain where systems meet. Aleph REST API External system Aleph IGeLU 2014 Page 20

Useful Links REST architecture http://www.slideshare.net/cebartling/rest-web-services Aleph REST API https://developers.exlibrisgroup.com/aleph/apis/Aleph-RESTful-APIs Aleph X-server https://developers.exlibrisgroup.com/aleph/apis/Aleph-X-Services Ex Libris Developer Network https://developers.exlibrisgroup.com/ Aleph IGeLU 2014 Page 21