Skip to main content
ExLibris

Knowledge Assistant

BETA
Back
Alma

 

Ex Libris Knowledge Center
  1. Search site
    Go back to previous article
    1. Sign in
      • Sign in
      • Forgot password
  1. Home
  2. Alma
  3. Best Practices and How-Tos
  4. APIs
  5. Best Practice Toolkits
  6. Best Practice Toolkit: Alma API

Best Practice Toolkit: Alma API

  1. Last updated
  2. Save as PDF
  3. Share
    1. Share
    2. Tweet
    3. Share
  1. What is it?
  2. Where is it?
  3. To use REST APIs:
  4. To create and manage my own APIs
  5. Related articles:

What is it?

Alma REST APIs (REpresentational State Transfer Application Programming Interface) provide access[AC1]  to data and workflows stored in Alma. REST APIs enable institutions to integrate Ex Libris solutions with local systems, create innovative services, increase the value of the library and help meet the institution’s goals and objectives.

REST APIs can use these HTTP protocols, such as:

  • GET (read data)
  • POST (write data)
  • DELETE (delete data)
  • PUT (update/replace data)

Ex Libris has created a wide range of Alma REST APIs including:

  • Acquisitions
  • Analytics
  • Bibliographic Records and Inventory
  • Configuration and Administration
  • Courses
  • Provider Zone
  • Electronic Resources
  • Resource Sharing Partners
  • Task Lists
  • Users and Fulfillment

Where is it?

Try the API by logging in here with the credentials provided to you: https://developers.exlibrisgroup.com/alma/apis/

clipboard_e189b50032586fd3915adbd2639767e41.png

To use REST APIs:

Choose the Alma documentation in the Learn tab.

clipboard_ee82389a557df092e968ce8422d3198df.png

Click Read more under the Alma REST API tab.

clipboard_e1379d066d241dd6305d0c99db284868a.png

Choose the areas you are interested in on the left:

clipboard_efc78acab5fbfe295411b8bdc582ffb6a.png

Click View Doc on the right-hand side on the API row.

clipboard_e350e6cbdcfcccf3b72ef1a122fbd7edd.png

Click Try it Now:

clipboard_ebc3ce47a815fb5f2efa826beb1f9c733.png

This brings you to the API console page. Click the API that you want to try:

clipboard_efe62817b21b3610db908e77c0d889a6e.png

Review the input parameter and response objects, click Try it out on the right to input the specified parameters and desired return format.

clipboard_ec6f5c768159fac4b8b6c7820f7989e85.png

Click Execute.

clipboard_ee45b72680eaea4d10c99968535198bd1.png

View the results, curl, request URL and syntax. You can copy or download the response body.

clipboard_ed4dec09c9326fcc8762b032a20e2cbe0.png

The Curl or Request URL can be used as syntax for applications with which your institution is integrating.

clipboard_e688b74a92f7bde016cea11d52e3fe6be.png

To create and manage my own APIs

Go to the Build my APIs tab on the Developer Network. Click Manage keys.

clipboard_e8b012161c322c79f4ab575a24d41feab.png

Click Add API Key to create an API key for an area of Alma, e.g.: Acquisitions, for read and write in the production environment.

clipboard_ef1638aa84de5f54b462ef095ed2ad477.png

Name your API key and add permission. Click Save.

clipboard_e1b464e3aef788b7be093d84d86642b88.png

Now the new API Key appears in the API console list and you can use it. You can click Copy next to it to copy it.

clipboard_ec571d31b1c75956e126b78c4a693b702.png

 

Related articles:

https://knowledge.exlibrisgroup.com/Alma/Best_Practices_and_How-Tos/APIs

https://knowledge.exlibrisgroup.com/Alma/Training/Extended_Training/Presentations_and_Documents_-_APIs

 

View article in the Exlibris Knowledge Center
  1. Back to top
    • Best Practice Toolkits
    • Miscellaneous
  • Was this article helpful?

Recommended articles

  1. Article type
    How-To
    Content Type
    Documentation
    Language
    English
    Product
    Alma
  2. Tags
    This page has no tags.
  1. © Copyright 2025 Ex Libris Knowledge Center
  2. Powered by CXone Expert ®
  • Term of Use
  • Privacy Policy
  • Contact Us
2025 Ex Libris. All rights reserved