Updated Koha connector #2
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Explicitly load all org unit types at page startup so that we fetch org types that may not have an org unit attached. Signed-off-by: Bill Erickson <[email protected]> Signed-off-by: Dawn Dale <[email protected]> Signed-off-by: Chris Sharp <[email protected]> Signed-off-by: Galen Charlton <[email protected]>
This updates the Koha connector to use various Koha API endpoints where possible. In particular, it uses the legacy /svc endpoint to create bibs and items. It uses the Koha REST API for item retrieval and placing holds, but uses the REST API extensions from https://github.com/NatLibFi/koha-plugin-rest-di to implement patron authentication, as the Koha REST API currently has no endpoint for verifying the validity of the credentials other than the API user itself. It defaults to SIP2 for checkouts and checkins. Resolving Koha bug 23336 would allow the REST API to be used. Assuming that a single main user is used to access the API, the following connector parameters are generally needed: * Connector svc API host (for Koha) - this is new, and should be set to the staff hostname * Connecter svc API user (for Koha) - also new * Connector svc API password (for Koha) - also new * Default Connector Host - should be set to the OPAC username * Default Connector User - this should be set to the OAuth client ID of the chosen staff user accessing the API * Default Connector Password - this should be set to the OAuth secret of the staff user accessing the API * SIP2 Hostname * SIP2 institution * SIP2 port * SIP2 login username * SIP2 login password Installation steps need for the Koha-side: * Install and set up the https://github.com/NatLibFi/koha-plugin-rest-di plugin * Enable the RESTOAuth2ClientCredentials system preference * Create a staff user with the following permissions: - circulate - catalogue - borrowers - reserveforothers - editcatalogue * Create API keys for that staff user The connector requires that the Koha version be at least 21.05. Signed-off-by: Galen Charlton <[email protected]>
The Koha connector needs to use both the legacy /svc API (to create temporary bibs and items) and its RESTful API. Since the RESTful API uses OAuth-derived tokens and is accessed from the OPAC host but the /svc API uses username/passwords and is accessed from the staff interface host, we need the extra settings. Signed-off-by: Galen Charlton <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.