Related Topics

HOWTO: Creating Encrypted Passwords for ILLiad Patron Loads
INFO: Expiration Date Field in the Users Table
INFO: Authentication Types in ILLiad
INFO: Basic ILLiad Authentication
INFO: LDAP Authentication

Other Support Options

Contact Atlas Systems
Phone Numbers, Support Options, Online Help, and more.
Listserv
Pose a question to other users.

Page Tools

Print this page Print this page
E-mail this page E-mail this page

Feedback

How helpful was this article?
Suggestions:

Revised: October 15,2007(gp)
Version:All DLL Versions
Revision:1
HOWTO: Setting Up PatronAPI Authentication
January 5, 2006

SUMMARY

In order to authenticate using PatronAPI, there are several keys that need to be set in the Customization Manager under Web Interface .. Innopac. The keys are described below.

EXAMPLES

InnopacPatronAPIAddress: This the the location of the PatronAPI server. Normally, the key also has a port after it of 4500. An example value would be http://123.123.123.123:4500 - where 123.123.123.123 is the PatronAPI server at your site. Also, the ILLiad server needs to have access to query the PatronAPI server. Most PatronAPI servers restrict access by ip address.

InnopacPatronAPIExclusive: This key should be set to Noif customers not in the PatronAPI server should still be allowed to register and Yes to only allow customers who pass the PatronAPI authentication to register with ILLiad.

InnopacPatronAPIExpireDate: Set this key to Yes to have ILLiad check if a customer is expired before allowing registration.

InnopacPatronAPIField: This is the field that ILLiad sends to the PatronAPI server for authentication. Currently the only two values allowed for this field are SSN or Number.

InnopacPatronAPIFineBlock: Set this key to Yes to have ILLiad check if a customer has exceeded his or her fine limit beforing allowing registration. If this is set to Yes, there needs to be a key for every Patron Code allowed to use ILLiad. There are some examples in a default installation of 0, 1, 2, etc. But for each code, there needs to be the value for number of dollars before customers can no longer register or use ILLiad.

InnopacPatronAPISupport: Set this key to Yes to turn on PatronAPI authentication.

TESTING CONNECTIVITY WITH YOUR PATRONAPI SERVER

You can test connectivity to your PatronAPI server using an Internet browser by following the instructions in the Innovative User Manual Patron API section headed "Accessing the Patron Data". 

If you receive a message like the following, you do not have access from the machine from which you tried to connect.

403 Forbidden
No access permitted from 123.123.123.123

If you receive a response with field names and data from your test patron (as shown in the Innovative User Manual Patron API section headed "Accessing the Patron Data"), you have the appropriate level of access.