{"id":21198699,"url":"https://github.com/natlibfi/koha-plugin-rest-di","last_synced_at":"2025-07-10T06:30:40.372Z","repository":{"id":38845907,"uuid":"235759709","full_name":"NatLibFi/koha-plugin-rest-di","owner":"NatLibFi","description":"REST API plugin for Koha to provide additional functionality for discovery interfaces such as VuFind","archived":false,"fork":false,"pushed_at":"2025-05-07T11:56:15.000Z","size":237,"stargazers_count":9,"open_issues_count":3,"forks_count":9,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-05-07T12:42:07.272Z","etag":null,"topics":["koha","koha-plugin","rest","rest-api","vufind"],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NatLibFi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-01-23T09:12:53.000Z","updated_at":"2025-05-07T11:56:19.000Z","dependencies_parsed_at":"2023-10-16T19:37:14.224Z","dependency_job_id":"d3294f22-2107-4a83-b623-82e18ec07731","html_url":"https://github.com/NatLibFi/koha-plugin-rest-di","commit_stats":null,"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"purl":"pkg:github/NatLibFi/koha-plugin-rest-di","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLibFi%2Fkoha-plugin-rest-di","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLibFi%2Fkoha-plugin-rest-di/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLibFi%2Fkoha-plugin-rest-di/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLibFi%2Fkoha-plugin-rest-di/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NatLibFi","download_url":"https://codeload.github.com/NatLibFi/koha-plugin-rest-di/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLibFi%2Fkoha-plugin-rest-di/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264538580,"owners_count":23624436,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["koha","koha-plugin","rest","rest-api","vufind"],"created_at":"2024-11-20T19:53:02.080Z","updated_at":"2025-07-10T06:30:40.366Z","avatar_url":"https://github.com/NatLibFi.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koha-plugin-rest-di\n\nThis is a REST API plugin for Koha. It provides extended API support for Discovery Interfaces such as VuFind.\n\nNote that this plugin requires Koha functionality that is only available from Koha 23.11. Releases for other versions are also available.\n\nMost of the functionality has been ported from the KohaSuomi version of Koha (see  https://github.com/KohaSuomi/Koha).\n\nNot all the functionality has been thoroughly tested yet.\n\nSee CHANGELOG.md for information about changes in this plugin.\n\n## Downloading\n\nYou can download the relevant *.kpz file from the [release page](https://github.com/NatLibFi/koha-plugin-rest-di/releases).\n\nLatest version may not support older Koha versions. Please choose an appropriate version.\n\n## Installing\n\nThe plugin is installed by uploading the KPZ (Koha Plugin Zip) package of a released version on the Manage Plugins page of the Koha staff interface.\n\nTo set up the Koha plugin system you must first make some changes to your install:\n\n1. Change `\u003cenable_plugins\u003e0\u003cenable_plugins\u003e` to ` \u003cenable_plugins\u003e1\u003c/enable_plugins\u003e` in your koha-conf.xml file.\n2. Confirm that the path to `\u003cpluginsdir\u003e` exists, is correct, and is writable by the web server.\n3. Restart your webserver.\n\nOnce the setup is complete you will need to enable plugins by setting UseKohaPlugins system preference to 'Enable'.\n\nYou can upload and configure the plugin on the Administration -\u003e Plugins -\u003e Manage Plugins page.\n\n### Required User Permissions\n\nTo use all the functionality the plugin provides, the following permissions are needed for the user account used to authenticate for the API:\n\n - circulate_remaining_permissions\n - catalogue\n - borrowers\n   - edit_borrowers\n   - view_borrower_infos_from_any_libraries\n - reserveforothers\n - modify_holds_priority\n - place_holds\n - updatecharges\n   - payout\n   - remaining_permissions\n\n### Installing without a KPZ package\n\nIf you need to use the plugin without a KPZ package (e.g. to use a version cloned from git):\n\n1. As above, make sure the plugin system is configured and enabled.\n2. Create the path Koha/Plugin/Fi/KohaSuomi/ under the ` \u003cpluginsdir\u003e`\n3. Symlink the DI.pm file and DI directory to the Koha/Plugin/Fi/KohaSuomi/ directory.\n4. Add data for the plugin to Koha's MySQL database by running Koha's misc/devel/install_plugins.pl script from the command line.\n\n## Building a Release\n\nA GitHub Action will build the release provided the commit includes a suitable version tag:\n\n1. `git tag -a vX.Y.Z -m \"Release X.Y.Z\"` (Feel free to provide a longer message too, it's displayed on the Releases page)\n2. `git push --tags origin main`\n\nTo manually build a release locally, run `./build.sh`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatlibfi%2Fkoha-plugin-rest-di","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatlibfi%2Fkoha-plugin-rest-di","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatlibfi%2Fkoha-plugin-rest-di/lists"}