Service Name Logging in PatronValidate API
This proposal outlines an extension to the Patron Validation API to include an optional serviceName parameter. When provided, this value will be recorded in the Integrated Library System (ILS) transaction log, allowing us to track which service initiates each patron validation request.
Currently, the ILS transaction log records patron validations without capturing which service initiated the request. This lack of context makes it difficult to analyze traffic from third-party services (e.g., OverDrive, Hoopla) or internal applications, troubleshoot validation spikes, and make informed decisions about service contracts and resource allocation.
The proposed solution is to modify the Patron Validation API to accept an optional serviceName parameter. If the serviceName is included, the API will pass it to the ILS for logging. If omitted, the validation will proceed as normal to ensure full backward compatibility with existing integrations.
Benefits
Enhanced Analytics: Generate reports on service usage to inform vendor negotiations and collection development.
Improved Troubleshooting: Quickly identify the source of performance issues or high traffic to reduce resolution time.
Data-Driven Decisions: Use service usage patterns to guide technology investments and integrations.
Backward Compatibility: The optional parameter ensures existing applications continue to function without modification.

-
Lynn Reynish commented
I can definitely see the value in this - either using the original concept or the alternative of passing the API key along.
-
Stacey McClain commented
This would be super helpful. We were able to identify such connections in our previous ILS and would love to see this in Polaris.
-
Wes Osborn commented
It would be SUPER to be able to get a better handle on who is authenticating.
Or, we'd also be fine with recording the API key used in the transaction database when a patron validates. Since those would be required, we'd always have access to the information.