docs/admin/ebook_api.adoc

   1 Ebook API integration
   2 ---------------------
   3
   4 Evergreen supports integration with third-party APIs provided by OverDrive and
   5 OneClickdigital.
   6
   7 When ebook API integration is enabled, the following features are supported:
   8
   9  * Bibliographic records from these vendors that appear in your
  10 public catalog will include vendor holdings and availability information.
  11  * Patrons can check out and place holds on OverDrive and OneClickdigital ebook
  12 titles from within the public catalog.
  13  * When a user is logged in, the public catalog dashboard and My Account
  14 interface will include information about that user's checkouts and holds for
  15 supported vendors.
  16
  17 [WARNING]
  18 The ability to check out and place holds on ebook titles is an experimental
  19 feature in 3.0.  It is not recommended for production use without careful
  20 testing.
  21
  22 For API integration to work, you need to request API access from the
  23 vendor and configure your Evergreen system according to the instructions
  24 below.  You also need to configure the new `open-ils.ebook_api` service.
  25
  26 This feature assumes that you are importing MARC records supplied by the
  27 vendor into your Evergreen system, using Vandelay or some other MARC
  28 import method.  This feature does not search the vendor's online
  29 collections or automatically import vendor records into your system; it
  30 merely augments records that are already in Evergreen.
  31
  32 A future Evergreen release will add the ability for users to check out
  33 titles, place holds, etc., directly via the public catalog.
  34
  35 Ebook API service configuration
  36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  37 This feature uses the new `open-ils.ebook_api` OpenSRF service.  This
  38 service must be configured in your `opensrf.xml` and `opensrf_core.xml`
  39 config files for ebook API integration to work.  See
  40 `opensrf.xml.example` and `opensrf_core.xml.example` for guidance.
  41
  42 OverDrive API integration
  43 ~~~~~~~~~~~~~~~~~~~~~~~~~
  44 Before enabling OverDrive API integration, you will need to request API
  45 access from OverDrive.  OverDrive will provide the values to be used for
  46 the following new org unit settings:
  47
  48   * *OverDrive Basic Token*: The basic token used for API client
  49     authentication.  To generate your basic token, combine your client
  50     key and client secret provided by OverDrive into a single string
  51     ("key:secret"), and then base64-encode that string.  On Linux, you
  52     can use the following command: `echo -n "key:secret" | base64 -`
  53   * *OverDrive Account ID*: The account ID (a.k.a. library ID) for your
  54     OverDrive API account.
  55   * *OverDrive Website ID*: The website ID for your OverDrive API
  56     account.
  57   * *OverDrive Authorization Name*: The authorization name (a.k.a.
  58     library name) designated by OverDrive for your library.  If your
  59     OverDrive subscription includes multiple Evergreen libraries, you
  60     will need to add a separate value for this setting for each
  61     participating library.
  62   * *OverDrive Password Required*: If your library's OverDrive
  63     subscription requires the patron's PIN (password) to be provided
  64     during patron authentication, set this setting to "true."  If you do
  65     not require the patron's PIN for OverDrive authentication, set this
  66     setting to "false."  (If set to "true," the password entered by a
  67     patron when logging into the public catalog will be cached in plain text in
  68     memcached.)
  69   * *OverDrive Discovery API Base URI* and *OverDrive Circulation API
  70     Base URI*: By default, Evergreen uses OverDrive's production API, so
  71     you should not need to set a value for these settings.  If you want
  72     to use OverDrive's integration environment, you will need to add the
  73     appropriate base URIs for the discovery and circulation APIs.  See
  74     OverDrive's developer documentation for details.
  75   * *OverDrive Granted Authorization Redirect URI*: Evergreen does not
  76     currently support granted authorization with OverDrive, so this
  77     setting is not currently in use.
  78
  79 For more information, consult the
  80 https://developer.overdrive.com/docs/getting-started[OverDrive API
  81 documentation].
  82
  83 To enable OverDrive API integration, adjust the following public catalog settings
  84 in `config.tt2`:
  85
  86   * `ebook_api.enabled`: set to "true".
  87   * `ebook_api.overdrive.enabled`: set to "true".
  88   * `ebook_api.overdrive.base_uris`: list of regular expressions
  89     matching OverDrive URLs found in the 856$9 field of older OverDrive
  90     MARC records.  As of fall 2016, OverDrive's URL format has changed,
  91     and the record identifier is now found in the 037$a field of their
  92     MARC records, with "OverDrive" in 037$b.  Evergreen will check the
  93     037 field for OverDrive record identifiers; if your system includes
  94     older-style OverDrive records with the record identifier embedded in
  95     the 856 URL, you need to specify URL patterns with this setting.
  96
  97 OneClickdigital API integration
  98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  99 Before enabling OneClickdigital API integration, you will need to
 100 request API access from OneClickdigital.  OneClickdigital will provide
 101 the values to be used for the following new org unit settings:
 102
 103   * *OneClickdigital Library ID*: The identifier assigned to your
 104     library by OneClickdigital.
 105   * *OneClickdigital Basic Token*: Your client authentication token,
 106     supplied by OneClickdigital when you request access to their API.
 107
 108 For more information, consult the
 109 http://developer.oneclickdigital.us/[OneClickdigital API documentation].
 110
 111 To enable OneClickdigital API integration, adjust the following public catalog
 112 settings in `config.tt2`:
 113
 114   * `ebook_api.enabled`: set to "true".
 115   * `ebook_api.oneclickdigital.enabled`: set to "true".
 116   * `ebook_api.oneclickdigital.base_uris`: list of regular expressions
 117     matching OneClickdigital URLs found in the 859$9 field of your MARC
 118     records.  Evergreen uses the patterns specified here to extract
 119     record identifiers for OneClickdigital titles.
 120
 121 Additional configuration
 122 ~~~~~~~~~~~~~~~~~~~~~~~~
 123 Evergreen communicates with third-party vendor APIs using the new
 124 `OpenILS::Utils::HTTPClient` module.  This module is configured using
 125 settings in `opensrf.xml`.  The default settings should work for most
 126 environments by default, but you may need to specify a custom location
 127 for the CA certificates installed on your server.  You can also disable
 128 SSL certificate verification on HTTPClient requests altogether, but
 129 doing so is emphatically discouraged.