About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
configuration:ils:examples:koha_rest_plugin

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
configuration:ils:examples:koha_rest_plugin [2023/02/27 16:29] – [Configure the EnvAuthorisation setting] demiankatzconfiguration:ils:examples:koha_rest_plugin [2023/05/03 16:39] (current) – [Installing and Configuring Koha's REST Plugin] demiankatz
Line 1: Line 1:
 ====== Installing and Configuring Koha's REST Plugin ====== ====== Installing and Configuring Koha's REST Plugin ======
  
-// Thanks to Mohan Pradhan for developing this documentation. //+// Thanks to Mariyapillai Jayakananthan and Mohan Pradhan for developing this documentation. //
  
 ** Prerequisite ** ** Prerequisite **
Line 45: Line 45:
 2. Download the most up-to-date .kpz plugin file from https://github.com/NatLibFi/koha-plugin-rest-di/releases. 2. Download the most up-to-date .kpz plugin file from https://github.com/NatLibFi/koha-plugin-rest-di/releases.
  
-3. In the Koha staff interface, go to: ''Home-> Koha administration-> Global system preferences-> Web services'' and find the REST API section. By default, it is set to 'Disable.' +3. In the Koha staff interface, go to: **Home -> Koha administration -> Global system preferences -> Web services** and find the REST API section. By default, it is set to 'Disable.' 
  
-Set each dropdown (RESTBasicAuth, RESTOauth2ClientCredentials, RESTPublicAnonymousRequests and RESTPublicAPI) to 'Enable' and then click the "Save all Web service preferencesbutton, as shown below: +Set each dropdown (RESTBasicAuth, RESTOauth2ClientCredentials, RESTPublicAnonymousRequests and RESTPublicAPI) to 'Enable' and then click the **Save all Web service preferences** button, as shown below: 
  
 {{ :configuration:ils:examples:screenshot3.png |}} {{ :configuration:ils:examples:screenshot3.png |}}
Line 53: Line 53:
 ==== Upload the Plugin ==== ==== Upload the Plugin ====
  
-Go to Home -> Administration  and click Manage Plugins. The output will be as follows:+Go to **Home -> Administration**  and click **Manage Plugins**. The output will be as follows:
  
 {{ :configuration:ils:examples:screenshot4.png |}} {{ :configuration:ils:examples:screenshot4.png |}}
Line 65: Line 65:
 Choose the file you downloaded earlier (the filename will be something similar to ''koha-plugin-rest-di-22.05.06.kpz''), and click the **Upload** button. Choose the file you downloaded earlier (the filename will be something similar to ''koha-plugin-rest-di-22.05.06.kpz''), and click the **Upload** button.
  
-When you view the Plugins list, you will see that the REST API plugin is set as DISABLED. Go to Actions at the far right and select Enable, as shown below.+When you view the Plugins list, you will see that the REST API plugin is set as DISABLED. Go to **Actions** at the far right and select **Enable**, as shown below.
  
 {{ :configuration:ils:examples:screenshot6.png |}} {{ :configuration:ils:examples:screenshot6.png |}}
Line 132: Line 132:
 {{ :configuration:ils:examples:screenshot14.png |}} {{ :configuration:ils:examples:screenshot14.png |}}
  
-Note the Client ID and Secret key.+Note the Client ID and Secret key; you will need these later when [[configuration:ils:examples:koharest_driver|configuring the KohaRest ILS driver]].
  
 ==== Verify whether the API is working ==== ==== Verify whether the API is working ====
Line 152: Line 152:
 If it is already enabled, disable and save it. Then enable it again and save it.  If it is already enabled, disable and save it. Then enable it again and save it. 
  
-Now recheck again with the command+Now recheck again by again trying to access the URL:
  
 <code bash> <code bash>
configuration/ils/examples/koha_rest_plugin.1677515385.txt.gz · Last modified: 2023/02/27 16:29 by demiankatz