Skip to content

Alma APIs in Airflow

jim hahn edited this page Jul 28, 2023 · 17 revisions

Airflow Connection

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

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

  • Conn Id: penn_alma_connection
  • Conn Type: HTTP
  • Host: {uri_region}/almaws/v1/bibs?

Airflow Variables

The Alma POST task requires Airflow Variables to be set:

  • import_profile_id (optional): (found in shared_configs)
  • alma_api_key: (found in shared_configs)
  • alma_uri_region: (see below)

Set one of the following for an Alma DAG variable of

  • North America Region value: https://api-na.hosted.exlibrisgroup.com
  • Europe Region value: https://api-eu.hosted.exlibrisgroup.com
  • Asia Pacific Region value: https://api-ap.hosted.exlibrisgroup.com
  • Canada Region value: https://api-ca.hosted.exlibrisgroup.com
  • China Region value: https://api-cn.hosted.exlibrisgroup.com.cn
Clone this wiki locally