Page History

Purpose

If any of your content integrations rely on Adobe DRM, the library you are configuring must be registered with NYPL's Adobe Vendor ID service.  This registration will create a Short Client Token that is used to identify the bearer of that token as a patron of that particular library.  NYPL will register the library's information with the Vendor ID service, and give you back a token string that you will then register with the library's circulation serverThis article describes the second half of the library registration process with NYPL (see Obtain a DRM Client Secret from NYPL for the first part). This registration is required whenever any of the library's ebook providers rely on Adobe DRM protection (Overdrive, Axis 360, Bibliotheca, etc.). In addition to obtaining the client data from NYPL, you must have already completed the process to Create a New Library. When you've completed that process, you're ready to configure the library's short client token.

Step-by-step guide

You can actually configure the client token using either the circ-scripts or circ-webapp containers. The containers currently (v2.2.5) have slightly different entry paths, but otherwise the process is the same. Use the information you obtained from NYPL in the previous step, Obtain a DRM Client Secret from NYPL, to substitute for the placeholders shown in the following steps:

1. Log into the circ-scripts container's host instance
2. Enter the container: sudo docker exec -it circ-scripts /bin/bash
3. Activate the Python virtual environment: source ../env/bin/activate
4. Run the script: ./configuration
5. Gather the following items for the library:
   
   1. Library name
   2. Short name for the library - this is by convention the two character state abbreviation, plus a three character library designation.  For example, MNGRR for Great River Regional Library in Minnesota.
   3. The url for the library's website.
6. Ask in the #devops channel on the LibrarySimplified slack team, that you need a short client token for your library and send those three items to the respondent.
7. You will receive back a 16 character short client token string.  This is the secret that you will register with your circulation server.
8. On your circulation server, connect to the circ-scripts docker container

   1. sudo docker exec -it circ-scripts /bin/bash

9. In the bin/configuration folder in the circulation server codebase, execute short_client_token_library_configuration script with the parameters you have along with the secret you received from NYPL.

   ./short_client_token_library_configuration --website-url <url> --short-name <short_name> <shortname> --secret <secret>

    

...

1. <shared_secret>
2. To finish, deactivate the virtual environment: deactivate
3. Exit the container: exit

Related articles

...