Alma provides the ability to access data via API calls, using scripts or tools like Postman.
We have a daily limit of API calls for all work done by the libraries, which includes requesting items, accessioning and managing records between CAIASoft and Alma, printing spine labels, and other workflows.
Because we do not have unlimited API access, we are being cautious in distributing API keys beyond those needed for core library workflows until we have a better understanding of how our transactions are counted.
When we cutover to Alma, we will begin to have API reporting tools available that will tell us how our usage of APIs compares to our cap number, and we will have a better sense of how broadly we can distribute API keys for various projects. In mid-August, we will also begin to have access to our premium sandbox, which will be a test environment with a snapshot of Duke’s data, allowing for testing of API tools prior to using them against production Alma.
We will update this page when we begin accepting requests for API keys.
In the meantime, if an API key is needed for a workflow, please open a support ticket via https://support.lib.duke.edu and assign it to the Alma queue.
API Key Distribution
API keys will be created by LSIS staff.
They will create distinct API keys for separate use cases, so that if a particular API key needs to be reset, it does not break multiple services.
Keys will be distributed via 1Password vaults.
Key requests need to specify
which environment the key is for - production or premium sandbox - you need two keys if you need to do the work in both environments
what type of access is needed
whether the access needed is read-only, or read/write.
Areas of access:
Acquisition
Analytics
Bibliographic Records and Inventory (Bibs)
Configuration
Courses
Electronic
Task-lists
Users
The API key breakdown roughly corresponds to how the API documentation is organized on https://developers.exlibrisgroup.com/alma/apis/