Alma APIs in Airflow

Airflow Connection

To use Alma APIs in Airflow, we need to set-up an Airflow HTTP Connection.

For example, setting a connection for Alma, the following fields need to be set:

• Conn Id: {sinopia_group_id}_alma_connection
• Conn Type: HTTP

Select one host for your region:

• Host: https://api-na.hosted.exlibrisgroup.com/almaws/v1/bibs?
• Host: https://api-eu.hosted.exlibrisgroup.com/almaws/v1/bibs?
• Host: https://api-ap.hosted.exlibrisgroup.com/almaws/v1/bibs?
• Host: https://api-ca.hosted.exlibrisgroup.com/almaws/v1/bibs?
• Host: https://api-cn.hosted.exlibrisgroup.com.cn/almaws/v1/bibs?

Airflow Variables

The Alma POST task requires Airflow Variables to be set:

• alma_api_key_{sinopia_group_id}: (found in shared_configs)
• alma_uri_region_{sinopia_group_id}: (in shared_configs)

Regions include:

• alma_uri_region_na: https://api-na.hosted.exlibrisgroup.com
• alma_uri_region_eu: https://api-eu.hosted.exlibrisgroup.com
• alma_uri_region_ap: https://api-ap.hosted.exlibrisgroup.com
• alma_uri_region_ca: https://api-ca.hosted.exlibrisgroup.com
• alma_uri_region_cn: https://api-cn.hosted.exlibrisgroup.com.cn