OverDrive API integration
Before enabling OverDrive API integration, you will need to request API
access from OverDrive. OverDrive will provide the values to be used for
the following new org unit settings:
-
OverDrive Basic Token: The basic token used for API client
authentication. To generate your basic token, combine your client
key and client secret provided by OverDrive into a single string
("key:secret"), and then base64-encode that string. On Linux, you
can use the following command:
echo -n "key:secret" | base64 -
-
OverDrive Account ID: The account ID (a.k.a. library ID) for your
OverDrive API account.
-
OverDrive Website ID: The website ID for your OverDrive API
account.
-
OverDrive Authorization Name: The authorization name (a.k.a.
library name) designated by OverDrive for your library. If your
OverDrive subscription includes multiple Evergreen libraries, you
will need to add a separate value for this setting for each
participating library.
-
OverDrive Password Required: If your library’s OverDrive
subscription requires the patron’s PIN (password) to be provided
during patron authentication, set this setting to "true." If you do
not require the patron’s PIN for OverDrive authentication, set this
setting to "false." (If set to "true," the password entered by a
patron when logging into the public catalog will be cached in plain text in
memcached.)
-
OverDrive Discovery API Base URI and OverDrive Circulation API
Base URI: By default, Evergreen uses OverDrive’s production API, so
you should not need to set a value for these settings. If you want
to use OverDrive’s integration environment, you will need to add the
appropriate base URIs for the discovery and circulation APIs. See
OverDrive’s developer documentation for details.
-
OverDrive Granted Authorization Redirect URI: Evergreen does not
currently support granted authorization with OverDrive, so this
setting is not currently in use.
For more information, consult the
OverDrive API
documentation.
To enable OverDrive API integration, adjust the following public catalog settings
in config.tt2:
-
ebook_api.enabled: set to "true".
-
ebook_api.overdrive.enabled: set to "true".
-
ebook_api.overdrive.base_uris: list of regular expressions
matching OverDrive URLs found in the 856$9 field of older OverDrive
MARC records. As of fall 2016, OverDrive’s URL format has changed,
and the record identifier is now found in the 037$a field of their
MARC records, with "OverDrive" in 037$b. Evergreen will check the
037 field for OverDrive record identifiers; if your system includes
older-style OverDrive records with the record identifier embedded in
the 856 URL, you need to specify URL patterns with this setting.
