Ex Libris APIs
For more information on how to use these APIs, including how to create an API key required for authentication, see [Alma REST…
AI & machine learning#openapi#text
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
For more information on how to use these APIs, including how to create an API key required for authentication, see Alma REST APIs.
Endpoints 10
Requested Resources
- GETGet Requested Resources
/almaws/v1/task-lists/requested-resources?library=string&circ_desk=string&location=&order_by=call_number&direction=asc&pickup_inst=&reported=&printed=&limit=10&offset=0This API returns a list of requested resources to be picked from the shelf in Alma - POSTAct on Requested Resources
/almaws/v1/task-lists/requested-resources?library=&circ_desk=&op=&location=&pickup_inst=&reported=&printed=This API performs an action on requested resources that are on the shelf in Alma
Lending Requests
- GETGet Lending Requests
/almaws/v1/task-lists/rs/lending-requests?library=&status=&printed=&reported=&partner=&requested_format=&supplied_format=This API returns a list of lending requests in Alma - POSTAct on Lending Requests
/almaws/v1/task-lists/rs/lending-requests?library=&op=&status=&printed=&reported=&partner=&requested_format=&supplied_format=This API preforms the requested action on a list (specified by given filters) of lending requests in Alma
Printouts
- GETRetrieve Printouts
/almaws/v1/task-lists/printouts?letter=ALL&status=ALL&printer_id=ALL&printout_id=ALL&limit=10&offset=0This API returns a list of Printouts. - POSTAct on Printouts
/almaws/v1/task-lists/printouts?letter=ALL&status=ALL&printer_id=ALL&printout_id=ALL&op=stringThis API performs an action on printouts: mark as printed or canceled. 10,000 records can be handled in one requests. Only printouts which were updated will… - GETRetrieve a Printout
/almaws/v1/task-lists/printouts/:printout_idThis Web service returns a Printout given a Printout ID. - POSTPrintout Service
/almaws/v1/task-lists/printouts/:printout_id?op=stringThis API operates on an printout. given a Printout ID.
Test
- GETGET Task-lists Test API
/almaws/v1/task-lists/testThis API is used to test if the API key was configured correctly.It returns a short XML (no schema available - the output is subject to changes) with the… - POSTPOST Task-lists Test API
/almaws/v1/task-lists/testThis API is used to test if the API key was configured correctly, including read/write permissions.It returns a short XML (no schema available - the output is…
API details
- Base URL
https://api-eu.hosted.exlibrisgroup.comhttps://api-na.hosted.exlibrisgroup.comhttps://api-ap.hosted.exlibrisgroup.comhttps://api-cn.hosted.exlibrisgroup.comhttps://api-ca.hosted.exlibrisgroup.com- Authentication
- An API key in the apikey query parameter
- Operations
- 10 operations on 6 pathsGET 5POST 5
- Main resources
- Printouts 4Lending Requests 2Requested Resources 2Test 2
- Response formats
application/jsonapplication/xml- Description format
- OpenAPI 3.0.1, API version
1.0 - Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Ex Libris APIs in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Ex Libris APIs collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the apikey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get Requested Resources” (GET /almaws/v1/task-lists/requested-resources?library=string&circ_desk=string&location=&order_by=call_number&direction=asc&pickup_inst=&reported=&printed=&limit=10&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Ex Libris APIs?
For more information on how to use these APIs, including how to create an API key required for authentication, see [Alma REST… It is listed under AI & machine learning and has 10 endpoints.
Who publishes the Ex Libris APIs?
It is listed from Exlibrisgroup's public API description (an OpenAPI document), not published by Exlibrisgroup on Swastik Codes. Anyone who controls exlibrisgroup.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Ex Libris APIs?
Its description lists 5 base URLs: https://api-eu.hosted.exlibrisgroup.com, https://api-na.hosted.exlibrisgroup.com, https://api-ap.hosted.exlibrisgroup.com, https://api-cn.hosted.exlibrisgroup.com, https://api-ca.hosted.exlibrisgroup.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Ex Libris APIs?
With an API key in the apikey query parameter.
How many endpoints does the Ex Libris APIs have?
10 operations on 6 paths (5 GET, 5 POST). The largest groups are Printouts, Lending Requests, Requested Resources, Test.
Is forking the Ex Libris APIs free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.