Tag: getting-started
AEK AI GPT ALMA ALMA-REFINE-CLOUD-APP ANALYTICS AngularJS PrimoVE Resource Sharing API campusM CLOUDAPPS CLOUDAPPS-HOW-TO CONCATENATION CONSORTIA COST-PER-USE CSS DATA-VISUALIZATION(DV) DIGITAL DISCOVERY FINANCE GENERAL-ELECTRONIC-SERVICES GETTING-STARTED Holdings Records HOW-TO-APIS-IN-5-EASY-STEPS JOBS LINKED-DATA NCIP Normalization rules OAI OAS OPENAPI Primo VE PRINTING PUBLISHING/EXPORT Python REAL-TIME-ACQUISITIONS REAL-TIME-ORDERING RESOURCE-SHARING SELF-CHECK SFX SIS SOCIAL-LOGIN SWORD TileSDK USERS WEB-OPAC WEBHOOKS
How to report on an API key by time range in five easy steps
ONE Log into the developers network and choose "Build my APIs > Reports > History > Group by API Key" TWO Choose desired date range THREE Click "Go" FOUR See results in desired time range. API Key names and last 4 digits appear in legend under graph (blacked out here for security) FIVE…
Error Handling with APIs
Errors happen, all the more so when working with external systems, so it's important that we handle them properly. As a part of the published Ex Libris philosophy for building REST APIs, errors are returned from Alma with a 400 response code and a response body with details on what caused the error. Sometimes error…
Getting Started Writing a Developer Network Blog Post
The Ex Libris developer community has a strong tradition of collaboration, and publishing a post on the Developer Network is a great way to share tips, tricks, success stories, how-to guides, and other content which can help your fellow developers fulfill the requirements of their respective institutions. In this post, we'll walk through the process…
Using the Data Updated As Of field to ensure that the analytics report API runs after ETL completes
In this blog we will describe how to use the “Data Updated As Of” field to ensure that a report will be retrieved by an API after the ETL completes.As a prerequisite for this blog it is highly recommended to first see:How to use an API to retrieve an Alma Analytics report in 5 easy…
How to use the "limit" and "ResumptionToken" in the "Retrieve Analytics report" API
In this blog we will describe how to use the "limit" and "ResumptionToken" parameters in the Retrieve Analytics Report API.As a prerequisite for this blog it is highly recommended to first see How to use an API to retrieve an Alma Analytics report in 5 easy steps.The "limit" and "ResumptionToken" parameters are explained in the…
How to report on an API area by time range in five easy steps
ONELog into the developers network and choose "Build my APIs > Reports > History > Group by API Area"TWOChoose desired date rangeTHREEClick "Go"FOURSee results in desired time rangeFIVENote that the desired date range is also included in the "Download in CSV" results
How to define an API key to work only within a specific IP range in five easy steps
In the example below we will use https://www.whatismyip.com/ to get our IP address.We will use https://www.ipaddressguide.com/cidr to convert the desired IP range to format CIDR (Classless Inter-Domain Routing).ONEOur IP address is 212.205.179.166The CIDR format for range 212.205.179.166 - 212.205.179.167 (which includes our IP address) is 212.205.179.166/31TWOWhen creating a new API key or editing an existing…
How to see an example of how the New Order API integration profile defines and finds a match on an existing record in five easy steps
In this blog post we will show that the New Order API integration profile is designed to match on an ISBN.We will then see that when a new order is created the order is attached to an existing bibliographic record if one exists with the same ISBN as in the input.As supplementary material see also:How…
How to create a resource sharing partner of type ISO 18626 via an API in 5 easy steps
This blog will focus on creating a resource sharing partner of type ISO 18626 via an API in your institution.The developer network already discusses resource sharing partners.See also in the developer network specifics regarding creating a partner.Additionally, the developer network provides a generic sample input file for the resource sharing partner in both XML and…
How to create and populate an itemized set via an API in 5 easy steps
In this blog post we will create an itemized set and add items to it using an API. Note that in order to create and populate the itemized set you will need an API key for read write in the configuration area. ONE Create the itemized set using this API with POST https://api-eu.hosted.exlibrisgroup.com/almaws/v1/conf/sets?combine=None&set1=None&set2=None&apikey=01234567890 Here is…