Tag: getting-started

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…

ALMA ANALYTICS GETTING-STARTED

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…

ALMA ANALYTICS GETTING-STARTED

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

ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS

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…

ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS

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…

ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS

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…

ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS

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…

ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS

How to run an import profile via an API in 5 easy steps
In this blog post we will run an import profile to import records into Alma using an API.Note that in order to retrieve profile IDs and Jobs IDs and run jobs you will need an API key for read write in the configuration area.ONEGet the import profile ID by retrieving (API GET) all import profiles…

ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS

How to use an API to retrieve the item Receiving number Weeding number and Weeding date in five easy steps
In the example here we will use an API to retrieve the item Receiving number, Weeding number and Weeding date.These fields will be present in the item recorded only if the relevant sequences are defined.  They and are not used by all institutions.See Configuring Physical Item Sequences for more information about the Receiving number, Weeding…

ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS

How to create an order with an interested user via an API in your institution in 5 easy steps
See also: How to create an order via an API in your institution in 5 easy steps.This blog will focus on creating an order with an interested user via an API in your institution.The developer network already discusses how to create an order using an API. See for example Create PO Line , specifically the…

ALMA GETTING-STARTED HOW-TO-APIS-IN-5-EASY-STEPS