oclc-api-bulk-updater

The beginnings of a generic bulk-updater for assorted OCLC APIs.

The present example updates patron records using the Identity Management API, but (almost) the same principles can apply to the Acquisitions APIs (Purchase Orders and Invoices), the Collection Management API for LHRs, the License Management API and even, mutatis mutandis, the Metadata API.

Prerequisites

You will need:

• A WSKEY and associated secret for the API you want to use
  • For the Identity Management API, you will have to request a WSKEY by emailing [email protected]. as explained here
  • For the other APIs, users who have the role WSKEY Admin at their institution can request a WSKEY from OCLC through the online form in the WSKEY Management interface
  • NOTE: the method you will use to authenticate when you use an OCLC API depends on the "Application Type" you select in the request form. To use client credentials grant as we do in this application, be sure to choose "Machine-to-Machine (M2M) App" when you request the WSKEY
• The proper scope identifier for the API you want to use
  • For the Identity Management API, the scope is SCIM
  • For other APIs, the scope names can be found in WSKEY Management record for the WSKEY -- for example, the Collection Management API's scope is WMS_COLLECTION_MANAGEMENT
• Your institution ID, which can be found using the WorldCat Registry
• A jq script to control the modifications to the records
  • the jq Manual has all the details
• A list of record identifiers
  • for the Identity Management example, this will be a list of patron barcodes, one barcode per line, in a file called, e.g., barcodes.txt

Setup

The script uses pyjq, which is a Python wrapper for jq, so jq has to be installed first.

Install the Python dependencies that will be imported by the script:

python3 -m pip install .

(or you may prefer to install the dependencies manually).

In the root directory, add a file called .env with the WSKEY, secret, and institution ID, e.g.:

WSKEY=NVuKm3Z...bRty4m
SECRET=MnVZt...3jwkL
INSTID=12345

Basic usage

Assuming you have your .env set up properly and a list of patron barcodes in patrons.txt:

python3 idm-update.py < patrons.txt

will respond, on success, with output like

12345678 200
12345679 200
...