From 0cb11bccd167d6950d139ae740a943f3012b6112 Mon Sep 17 00:00:00 2001 From: Galen Charlton Date: Mon, 14 Sep 2020 12:38:54 -0400 Subject: [PATCH] LP#1887196: add release notes Signed-off-by: Galen Charlton --- .../Administration/patronapi.adoc | 33 ++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/RELEASE_NOTES_NEXT/Administration/patronapi.adoc diff --git a/docs/RELEASE_NOTES_NEXT/Administration/patronapi.adoc b/docs/RELEASE_NOTES_NEXT/Administration/patronapi.adoc new file mode 100644 index 0000000000..9da1673255 --- /dev/null +++ b/docs/RELEASE_NOTES_NEXT/Administration/patronapi.adoc @@ -0,0 +1,33 @@ +"PatronAPI" authentication +^^^^^^^^^^^^^^^^^^^^^^^^^^ +Evergreen now supports the III "PatronAPI" scheme for authenticating +patrons and supplying some information about them. + +To enable this, you will need to: + +. Add a new User Activity Type to Evergreen for PatronAPI authentications. +. Add a new Remote Authentication Profile to Evergreen. You will probably want +to use `PatronAPI` as the name. +. Edit the `` stanza in Evergreen's eg_vhost configuration +file. In particular, you will need to allow access to it from the server(s) +wanting to make PatronAPI requests, determine whether to enable the PatronAPI +"dump" feature, and specify whether users can be identified by username +or barcode. +. Restart Apache. +. Update the PatronAPI client to use https://your.evergreen.server/api/patronapi + as its base URL. + +Example PatronAPI URLs look something like this: + +.PatronAPI URLs +---- +# test a patron's PIN: +https://evergreen.example.org/api/patronapi/USERNAME/PASSWORD/pintest + +# dump some information about the patron. Note that this +# does _not_ require the the patron's password be supplied. +https://evergreen.example.org/api/patronapi/USERNAME/dump +---- + +The responses for the `pintest` and `dump` actions are specified by +Template Toolkit templates under (e.g.) `/openils/var/templates/remoteauth`. -- 2.11.0