APIs

Alma REST APIs provide access to data and workflows stored in Alma. The Ex Libris Developer Network is your key to getting the most out of these APIs.

You can view all of the documentation and try out the APIs without logging in to the Developer Network. To use the APIs to access your institution's data, you'll need to sign into the Developer Network with credentials provided by OLS.

Getting Started

1. Go to the Ex Libris Developer Network: https://developers.exlibrisgroup.com
2. Log in with your credentials
   • Write to support@cuny-ols.libanswers.com if you do not already have credentials
   • Ignore the prompt to enable 2-factor authentication
3. Click "Build / My APIs" (blue banner)
4. In the "API Keys" section, click on "Manage Keys"
5. Click "Add API Key"
6. Click "Add Permission"
   
   1. Enter a name, description, etc.
   2. Click "Add Permission" and choose the area you need, environment ("Production"!), and permission ("Read-only," please!)
7. Repeat step 6 for each area of interest
8. Click "Save"
9. Go to "API Console" (grey banner) and select the area in which you have an API key; check the server and API key to make sure the correct ones are used
10. Try out the web services and use in your code as necessary!

Documentation

• Ex Libris Developer Network > Alma > REST APIs
• Ex Libris Developer Network > Alma > Webhooks