docs/modules/integrations/pages/patron-api.adoc

   1 = "PatronAPI" authentication =
   2
   3 Evergreen now supports the III "PatronAPI" scheme for authenticating
   4 patrons and supplying some information about them.
   5
   6 To enable this, you will need to:
   7
   8 . Add a new User Activity Type to Evergreen for PatronAPI authentications.
   9 . Add a new Remote Authentication Profile to Evergreen. You will probably want
  10 to use `PatronAPI` as the name.
  11 . Edit the `<Location /api/patronapi>` stanza in Evergreen's eg_vhost configuration
  12 file. In particular, you will need to allow access to it from the server(s)
  13 wanting to make PatronAPI requests, determine whether to enable the PatronAPI
  14 "dump" feature, and specify whether users can be identified by username
  15 or barcode.
  16 . Restart Apache.
  17 . Update the PatronAPI client to use https://your.evergreen.server/api/patronapi
  18   as its base URL.
  19
  20 Example PatronAPI URLs look something like this:
  21
  22 .PatronAPI URLs
  23 ----
  24 # test a patron's PIN:
  25 https://evergreen.example.org/api/patronapi/USERNAME/PASSWORD/pintest
  26
  27 # dump some information about the patron. Note that this
  28 # does _not_ require the the patron's password be supplied.
  29 https://evergreen.example.org/api/patronapi/USERNAME/dump
  30 ----
  31
  32 The responses for the `pintest` and `dump` actions are specified by
  33 Template Toolkit templates under (e.g.) `/openils/var/templates/remoteauth`.
  34