Alma and Primo APIs
- Karen Kohn (Unlicensed)
- Chad Nelson (Unlicensed)
- Emily Toner
An API is a protocol for transferring data in a structured form. Ex Libris offers APIs for retrieving data from our institution's Alma repository and the Primo Central Index (PCI). The Alma and Primo APIs are used in several units within the library. The Library Search, for example, relies on the Alma Bibs API's to retrieve real-time information about physical items (including availability) and to send item requests back to Alma. The APIs can also be used for some look-up functions as an alternative to Analytics.
Documentation:
- Alma Bibs API: access to bibliographic records related information, including catalog records, holdings, items, portfolios, loans, requests, etc.
- Alma Electronic API: access to electronic related information, including electronic collections, services, and portfolios
- Primo REST APIs
Access
If you believe the Alma and/or Primo APIs would be useful in your work, you may request a key that will authorize you to submit queries. To request a key, email tul-web-support@temple.edu.
When requesting access, please include and brief explanation of the data you want to gain access to and your use case. When you are given an API key, it will only have access to a subset of data types, like Bibliographic and Inventory Data, or Electronic Holdings Data. Providing an explanation will help ensure you get access to the right subset. The full list of data types are listed on the Alma and Primo api pages.
Permissions
By default, most API keys provide "Read Only" access to the subset of data they can access. This means you won't be able to make changes to the data using the API key. If your proposed use case includes writing data back to Alma, that will be considered on a case by case basis.
Access to user data via the API is also only granted on a case by case basis for user privacy reasons.
Support
There is no formal working group on APIs, but there is communication between people in different areas who use the APIs. Questions are welcome on the #code_questions Slack channel.